'1.0',
'info' => ['style' => 'RPC', 'product' => 'dataworks-public', 'version' => '2024-05-18'],
'directories' => [
[
'children' => [
[
'children' => ['CreateMcpServer', 'DeleteMcpServer', 'UpdateMcpServer', 'GetMcpServer', 'ListMcpServers'],
'type' => 'directory',
'title' => 'MCP 服务管理 / MCP Server',
'id' => 453657,
],
[
'children' => ['CreateSkill', 'DeleteSkill', 'GetSkill', 'ListSkills'],
'type' => 'directory',
'title' => '技能管理 / Skill',
'id' => 453658,
],
[
'children' => ['CreateAgent', 'ListCustomAgents', 'DeleteAgent', 'GetAgent', 'ListAgents'],
'type' => 'directory',
'title' => '智能体管理 / Agent',
'id' => 453659,
],
[
'children' => ['PromptAgentSession', 'LoadAgentSession', 'ListAgentSessions', 'ListAgentSessionArtifacts', 'GetAgentSessionTokenUsage', 'GetAgentSessionArtifactMeta', 'CreateAgentSession', 'CancelAgentSession'],
'type' => 'directory',
'title' => '会话管理 / Agent Session',
'id' => 453660,
],
],
'type' => 'directory',
'title' => 'Data Agent',
'id' => 453656,
],
[
'children' => [
[
'children' => ['CreateProject', 'DeleteProject', 'UpdateProject', 'ListProjects', 'GetProject'],
'type' => 'directory',
'title' => '工作空间',
'id' => 439826,
],
[
'children' => ['CreateProjectRole', 'DeleteProjectRole', 'UpdateProjectRole', 'GetProjectRole', 'ListProjectRoles'],
'type' => 'directory',
'title' => '空间角色',
'id' => 398747,
],
[
'children' => ['CreateProjectMember', 'DeleteProjectMember', 'GrantMemberProjectRoles', 'RevokeMemberProjectRoles', 'GetProjectMember', 'ListProjectMembers'],
'type' => 'directory',
'title' => '空间成员',
'id' => 398750,
],
],
'type' => 'directory',
'title' => '空间管理',
'id' => 398740,
],
[
'children' => [
'UpdateDataSource',
'TestDataSourceConnectivity',
'CreateDataSource',
'DeleteDataSource',
'CloneDataSource',
'ListDataSources',
[
'children' => ['CreateDataSourceSharedRule', 'DeleteDataSourceSharedRule', 'ListDataSourceSharedRules'],
'type' => 'directory',
'title' => '数据源分享规则',
'id' => 398735,
],
],
'type' => 'directory',
'title' => '数据源',
'id' => 398728,
],
[
'children' => ['DeleteComputeResource', 'GetComputeResource', 'UpdateComputeResource', 'ListComputeResources', 'CreateComputeResource'],
'type' => 'directory',
'title' => '计算资源',
'id' => 398992,
],
[
'children' => [
[
'children' => ['CreateResourceGroup', 'DeleteResourceGroup', 'UpdateResourceGroup', 'GetResourceGroup', 'ListResourceGroups', 'DissociateProjectFromResourceGroup', 'AssociateProjectToResourceGroup', 'ListResourceGroupAssociateProjects', 'ListResourceGroupMetricData'],
'type' => 'directory',
'title' => '资源组',
'id' => 398789,
],
[
'children' => ['CreateRoute', 'DeleteRoute', 'UpdateRoute', 'GetRoute', 'ListRoutes'],
'type' => 'directory',
'title' => '路由',
'id' => 398778,
],
[
'children' => ['CreateNetwork', 'DeleteNetwork', 'GetNetwork', 'ListNetworks'],
'type' => 'directory',
'title' => '网络',
'id' => 398784,
],
],
'type' => 'directory',
'title' => '资源组管理',
'id' => 398777,
],
[
'children' => ['GetImage', 'ListImages', 'ListImageVersions', 'AssociateProjectToImage', 'DissociateProjectFromImage', 'ListImageAssociatedProjects'],
'type' => 'directory',
'title' => '镜像管理',
'id' => 440295,
],
[
'children' => [
[
'children' => ['CreateComponent', 'DeleteComponent', 'GetComponent', 'UpdateComponent', 'ListComponents'],
'type' => 'directory',
'title' => '组件',
'id' => 398722,
],
[
'children' => ['CreateNode', 'DeleteNode', 'UpdateNode', 'MoveNode', 'RenameNode', 'GetNode', 'ListNodes', 'ListNodeDependencies'],
'type' => 'directory',
'title' => '节点',
'id' => 398706,
],
[
'children' => ['CreateWorkflowDefinition', 'ImportWorkflowDefinition', 'DeleteWorkflowDefinition', 'UpdateWorkflowDefinition', 'MoveWorkflowDefinition', 'RenameWorkflowDefinition', 'GetWorkflowDefinition', 'ListWorkflowDefinitions'],
'type' => 'directory',
'title' => '工作流定义',
'id' => 398697,
],
[
'children' => ['CreateResource', 'DeleteResource', 'UpdateResource', 'GetResource', 'ListResources', 'MoveResource', 'RenameResource'],
'type' => 'directory',
'title' => '资源',
'id' => 398681,
],
[
'children' => ['CreateFunction', 'DeleteFunction', 'UpdateFunction', 'MoveFunction', 'RenameFunction', 'GetFunction', 'ListFunctions'],
'type' => 'directory',
'title' => '函数',
'id' => 398689,
],
[
'children' => ['CreatePipelineRun', 'AbolishPipelineRun', 'ExecPipelineRunStage', 'GetPipelineRun', 'ListPipelineRuns', 'ListPipelineRunItems'],
'type' => 'directory',
'title' => '发布流程',
'id' => 398715,
],
],
'type' => 'directory',
'title' => '数据开发（新版）',
'id' => 398680,
],
[
'children' => [
[
'children' => ['CreateFile', 'CreateResourceFile', 'CreateUdfFile', 'UpdateFile', 'UpdateUdfFile', 'GetFile', 'ListFiles', 'SubmitFile', 'DeployFile'],
'type' => 'directory',
'title' => '文件',
'id' => 398935,
],
[
'children' => ['CreateFolder', 'DeleteFolder', 'UpdateFolder', 'GetFolder', 'ListFolders'],
'type' => 'directory',
'title' => '文件夹',
'id' => 398946,
],
[
'children' => ['CreateBusiness', 'DeleteBusiness', 'UpdateBusiness', 'GetBusiness', 'ListBusiness'],
'type' => 'directory',
'title' => '业务流程',
'id' => 398952,
],
[
'children' => ['GetDeploymentPackage', 'ListDeploymentPackages', 'ListDeploymentPackageFiles'],
'type' => 'directory',
'title' => '发布包',
'id' => 398958,
],
[
'children' => ['GetFileVersion', 'ListFileVersions'],
'type' => 'directory',
'title' => '文件版本',
'id' => 398962,
],
[
'children' => ['UpdateIDEEventResult', 'GetIDEEventDetail'],
'type' => 'directory',
'title' => '扩展点事件',
'id' => 398965,
],
[
'children' => ['EstablishRelationTableToBusiness'],
'type' => 'directory',
'title' => '表',
'id' => 398968,
],
],
'type' => 'directory',
'title' => '数据开发（旧版）',
'id' => 398934,
],
[
'children' => [
[
'children' => ['CreateDIJob', 'UpdateDIJob', 'DeleteDIJob', 'StopDIJob', 'StartDIJob', 'GetDIJob', 'GetDIJobLog', 'ListDIJobs', 'ListDIJobRunDetails', 'ListDIJobMetrics', 'ListDIJobEvents'],
'type' => 'directory',
'title' => '同步任务',
'id' => 398758,
],
[
'children' => ['CreateDIAlarmRule', 'UpdateDIAlarmRule', 'DeleteDIAlarmRule', 'ListDIAlarmRules'],
'type' => 'directory',
'title' => '任务告警',
'id' => 398770,
],
],
'type' => 'directory',
'title' => '数据集成',
'id' => 398757,
],
[
'children' => [
[
'children' => ['ListCustomAttributes', 'GetCustomAttribute', 'CreateCustomAttribute', 'UpdateCustomAttribute', 'DeleteCustomAttribute'],
'type' => 'directory',
'title' => '自定义属性',
'id' => 453539,
],
[
'children' => ['ListMetaEntityDefs', 'GetMetaEntityDef', 'CreateMetaEntityDef', 'UpdateMetaEntityDef', 'DeleteMetaEntityDef'],
'type' => 'directory',
'title' => '自定义元数据实体定义',
'id' => 453540,
],
[
'children' => ['ListCrawlerTypes'],
'type' => 'directory',
'title' => '元数据采集器类型',
'id' => 398883,
],
[
'children' => [
[
'children' => ['ListMetaEntities', 'GetMetaEntity', 'BatchCreateMetaEntities', 'UpdateMetaEntity', 'BatchDeleteMetaEntities'],
'type' => 'directory',
'title' => '自定义实体',
'id' => 453550,
],
[
'children' => ['ListCatalogs', 'GetCatalog'],
'type' => 'directory',
'title' => '数据目录',
'id' => 398886,
],
[
'children' => ['ListDatabases', 'GetDatabase'],
'type' => 'directory',
'title' => '数据库',
'id' => 398889,
],
[
'children' => ['ListSchemas', 'GetSchema'],
'type' => 'directory',
'title' => '模式',
'id' => 448113,
],
[
'children' => ['ListTables', 'GetTable', 'UpdateTableBusinessMetadata'],
'type' => 'directory',
'title' => '数据表',
'id' => 398895,
],
[
'children' => ['ListColumns', 'GetColumn', 'UpdateColumnBusinessMetadata'],
'type' => 'directory',
'title' => '字段',
'id' => 398899,
],
[
'children' => ['ListDatasets', 'GetDataset', 'CreateDataset', 'UpdateDataset', 'DeleteDataset'],
'type' => 'directory',
'title' => '数据集',
'id' => 448114,
],
[
'children' => ['ListDatasetVersions', 'GetDatasetVersion', 'CreateDatasetVersion', 'UpdateDatasetVersion', 'DeleteDatasetVersion', 'PreviewDatasetVersion'],
'type' => 'directory',
'title' => '数据集版本',
'id' => 398909,
],
],
'type' => 'directory',
'title' => '元数据实体',
'id' => 398885,
],
[
'children' => ['ListPartitions', 'GetPartition'],
'type' => 'directory',
'title' => '分区',
'id' => 398916,
],
[
'children' => ['ListLineageRelationships', 'GetLineageRelationship', 'DeleteLineageRelationship', 'CreateLineageRelationship', 'ListLineages'],
'type' => 'directory',
'title' => '血缘关系',
'id' => 398919,
],
[
'children' => ['ListMetaCollections', 'CreateMetaCollection', 'GetMetaCollection', 'UpdateMetaCollection', 'DeleteMetaCollection', 'ListEntitiesInMetaCollection', 'AddEntityIntoMetaCollection', 'RemoveEntityFromMetaCollection'],
'type' => 'directory',
'title' => '元数据集合',
'id' => 398925,
],
],
'type' => 'directory',
'title' => '数据地图',
'id' => 398882,
],
[
'children' => [
[
'children' => ['CreateParameter', 'DeleteParameter', 'UpdateParameter', 'RollbackParameter', 'GetParameter', 'ListParameters', 'ListParameterVersions'],
'type' => 'directory',
'title' => '参数',
'id' => 438597,
],
[
'children' => ['ListAlertRules', 'GetAlertRule', 'UpdateAlertRule', 'DeleteAlertRule', 'CreateAlertRule'],
'type' => 'directory',
'title' => '监控告警',
'id' => 398848,
],
[
'children' => ['DeleteTask', 'UpdateTask', 'BatchUpdateTasks', 'GetTask', 'ListTasks', 'ListUpstreamTasks', 'ListDownstreamTasks', 'ListTaskOperationLogs'],
'type' => 'directory',
'title' => '任务',
'id' => 398824,
],
[
'children' => ['UpdateTaskInstances', 'GetTaskInstance', 'GetTaskInstanceLog', 'ListTaskInstances', 'ListUpstreamTaskInstances', 'ListTaskInstanceOperationLogs', 'ListDownstreamTaskInstances', 'SuspendTaskInstances', 'ResumeTaskInstances', 'StopTaskInstances', 'SetSuccessTaskInstances', 'RerunTaskInstances', 'RemoveTaskInstanceDependencies', 'TriggerSchedulerTaskInstance'],
'type' => 'directory',
'title' => '任务实例',
'id' => 398833,
],
[
'children' => ['DeleteWorkflow'],
'type' => 'directory',
'title' => '工作流',
'id' => 398854,
],
[
'children' => ['GetRerunWorkflowInstancesResult', 'RerunWorkflowInstances', 'CreateWorkflowInstances', 'GetCreateWorkflowInstancesResult', 'GetWorkflowInstance', 'ListWorkflowInstances', 'StartWorkflowInstances', 'StopWorkflowInstances', 'ExecuteAdhocWorkflowInstance'],
'type' => 'directory',
'title' => '工作流实例',
'id' => 398859,
],
],
'type' => 'directory',
'title' => '运维中心',
'id' => 398823,
],
[
'children' => [
[
'children' => ['CreateDataQualityTemplate', 'UpdateDataQualityTemplate', 'ListDataQualityTemplates', 'GetDataQualityTemplate', 'DeleteDataQualityTemplate'],
'type' => 'directory',
'title' => '数据质量规则模板',
'id' => 398817,
],
[
'children' => ['CreateDataQualityScan', 'UpdateDataQualityScan', 'ListDataQualityScans', 'GetDataQualityScan', 'DeleteDataQualityScan'],
'type' => 'directory',
'title' => '数据质量监控',
'id' => 398800,
],
[
'children' => ['CreateDataQualityAlertRule', 'UpdateDataQualityAlertRule', 'ListDataQualityAlertRules', 'GetDataQualityAlertRule', 'DeleteDataQualityAlertRule'],
'type' => 'directory',
'title' => '告警规则',
'id' => 398806,
],
[
'children' => ['CreateDataQualityScanRun', 'ListDataQualityScanRuns', 'GetDataQualityScanRunLog', 'GetDataQualityScanRun'],
'type' => 'directory',
'title' => '数据质量运行',
'id' => 398812,
],
],
'type' => 'directory',
'title' => '数据质量',
'id' => 398799,
],
[
'children' => [
[
'children' => ['ApplyResourceAccessPermission', 'StopProcessInstance', 'ApproveProcessInstance', 'GetApplicationContents', 'GetProcessInstance', 'ListPendingApprovals', 'ListMyRelatedApprovals', 'ListMyApplications'],
'type' => 'directory',
'title' => '权限申请与审批',
'id' => 452759,
],
[
'children' => ['CreateSecurityStrategy', 'DeleteSecurityStrategy', 'UpdateSecurityStrategy', 'GetSecurityStrategy', 'ListSecurityStrategies', 'FindBestMatchSecurityStrategy'],
'type' => 'directory',
'title' => '查询结果管控策略',
'id' => 452760,
],
[
'children' => ['CreateProcessDefinition', 'DeleteProcessDefinition', 'EnableProcessDefinition', 'DisableProcessDefinition', 'UpdateProcessDefinition', 'GetProcessDefinition', 'ListProcessDefinitions'],
'type' => 'directory',
'title' => '审批策略',
'id' => 452761,
],
'CreateIdentifyCredential',
],
'type' => 'directory',
'title' => '安全中心',
'id' => 398998,
],
[
'children' => ['CreateDataAssetTag', 'DeleteDataAssetTag', 'UpdateDataAssetTag', 'ListDataAssetTags', 'TagDataAssets', 'UnTagDataAssets', 'ListDataAssets'],
'type' => 'directory',
'title' => '标签管理',
'id' => 398869,
],
[
'children' => ['GetJobStatus'],
'type' => 'directory',
'title' => '开放平台',
'id' => 398775,
],
[
'children' => [
'ListDataQualityEvaluationTasks', 'ListDataQualityRules', 'ListDataQualityEvaluationTaskInstances', 'ListDataQualityResults', 'DetachDataQualityRulesFromEvaluationTask', 'DeleteDataQualityEvaluationTask', 'GetDataQualityEvaluationTaskInstance', 'GetDataQualityEvaluationTask', 'AttachDataQualityRulesToEvaluationTask', 'UpdateDataQualityEvaluationTask', 'CreateDataQualityEvaluationTaskInstance', 'CreateDataQualityEvaluationTask', 'DeleteDataQualityRule', 'UpdateDataQualityRuleTemplate', 'CreateDataQualityRuleTemplate', 'DeleteDataQualityRuleTemplate', 'GetDataQualityRuleTemplate', 'CreateDataQualityRule', 'UpdateDataQualityRule', 'GetDataQualityRule',
'ListDataQualityRuleTemplates', 'DeleteCertificate', 'GetCertificate', 'GetDataSource', 'ImportCertificate', 'ListCertificates', 'DeleteFile', 'GetWorkflow', 'ListWorkflows', 'UpdateWorkflow',
],
'type' => 'directory',
'title' => '其他',
'id' => 398970,
],
],
'components' => [
'schemas' => [
'Catalog' => [
'cloudType' => 'public',
'branchId' => 5123041,
'branchName' => 'master',
'paramExtraInfo' => [
'$.components.schemas.Catalog.properties.Name.description' => '名称', '$.components.schemas.Catalog.properties.Type.example' => 'Internal', '$.components.schemas.Catalog.properties.ParentMetaEntityId.example' => 'dlf', '$.components.schemas.Catalog.properties.Comment.example' => 'this is a comment', '$.components.schemas.Catalog.properties.CreateTime.description' => '创建时间（毫秒级时间戳）', '$.components.schemas.Catalog.properties.Type.description' => '类目类型，取值与元数据采集器类型相关', '$.components.schemas.Catalog.properties.ModifyTime.example' => '1722073854000'."\n", '$.components.schemas.Catalog.description' => '元数据的数据目录。', '$.components.schemas.Catalog.properties.CreateTime.example' => '1722073854000', '$.components.schemas.Catalog.properties.Id.description' => '数据目录实体ID，当前支持dlf与starrocks类型，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'- 对于dlf类型，格式为 `dlf-catalog::catalog_id`'."\n"
."\n"
.'- 对于starrocks类型，格式为`starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`'."\n"
."\n"
.'> 其中 '."\n"
.'`catalog_id`: dlf目录id '."\n"
.'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`catalog_name`: starrocks目录名称',
'$.components.schemas.Catalog.properties.ModifyTime.description' => '修改时间（毫秒级时间戳）', '$.components.schemas.Catalog.properties.Name.example' => 'default_catalog', '$.components.schemas.Catalog.properties.ParentMetaEntityId.description' => '父层级实体ID'."\n"
."\n"
.'- 对于dlf类型，`ParentMetaEntityId`格式为 `dlf`'."\n"
."\n"
.'- 对于starrocks类型，`ParentMetaEntityId`格式为 `starrocks:(instance_id|encoded_jdbc_url)`'."\n"
."\n"
.'>其中 '."\n"
.'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供', '$.components.schemas.Catalog.properties.Id.example' => 'dlf-catalog::catalog_id', '$.components.schemas.Catalog.properties.Comment.description' => '注释',
],
'title' => '元数据数据目录',
'description' => '元数据的数据目录。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => 'ID，当前支持dlf与starrocks类型，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'- 对于dlf类型，当前仅支持dlf1.0，其ID格式为 `dlf-catalog:${主账号ID}:${数据目录名称}`'."\n"
."\n"
.'- 对于starrocks类型，其ID格式为 `starrocks-catalog:${实例ID或转义后的URL}:${数据目录名称}`', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf-catalog:123456XXX:test_catalog'."\n"
.'starrocks-catalog:c-abc123xxx:default_catalog', 'backendName' => 'id'],
'Name' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'default_catalog', 'backendName' => 'name'],
'Comment' => ['title' => '注释', 'description' => '注释', 'visibility' => 'Public', 'type' => 'string', 'example' => 'this is a comment'."\n", 'backendName' => 'comment'],
'Type' => ['title' => '类型', 'description' => '类目类型，取值与元数据采集器类型相关', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Internal', 'backendName' => 'type'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间（毫秒级时间戳）', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1722073854000', 'backendName' => 'createTime'],
'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间（毫秒级时间戳）', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1722073854000'."\n", 'backendName' => 'modifyTime'],
'ParentMetaEntityId' => ['title' => '父层级实体ID', 'description' => '父层级实体ID，当前支持`dlf`与`starrocks`类型。'."\n"
."\n"
.'- 对于`dlf`类型，当前仅支持`dlf1.0`，其实体ID为 `dlf`'."\n"
."\n"
.'- 对于`starrocks`类型，其实体ID格式为 `starrocks:${实例ID或转义后的URL}`', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf'."\n"
.'starrocks:c-abc123xxx', 'backendName' => 'parentMetaEntityId'],
],
],
'Column' => [
'title' => '数据表字段',
'description' => '字段。',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => 'ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}:${字段名称}`，对于不存在的层级使用空字符占位'."\n"
."\n"
.'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n"
."\n"
.'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n"
."\n"
.'几种常用类型的ID格式参考如下'."\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`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`catalog_id`: dlf目录ID '."\n"
.'`project_name`: maxcompute项目名称 '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供，若未开启则使用空字符占位。 '."\n"
.'`table_name`: 表名称 '."\n"
.'`column_name`: 字段名称', 'type' => 'string', 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name'],
'Name' => ['title' => '名称', 'description' => '名称。', 'type' => 'string', 'example' => 'column_name'],
'Comment' => ['title' => '注释', 'description' => '注释。', 'type' => 'string', 'example' => '字段1'],
'TableId' => ['title' => '所属表ID', 'description' => '数据表ID，可参考`Table`对象。', 'type' => 'string', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
'Position' => ['title' => '位置', 'description' => '位置。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Type' => ['title' => '类型', 'description' => '类型。', 'type' => 'string', 'example' => 'bigint'],
'PrimaryKey' => ['title' => '是否为主键', 'description' => '是否为主键, 当前仅MaxCompute类型支持。', 'type' => 'boolean', 'example' => 'false'],
'PartitionKey' => ['title' => '是否为分区键', 'description' => '是否为分区键。', 'type' => 'boolean', 'example' => 'false'],
'ForeignKey' => ['title' => '是否为外键', 'description' => '是否为外键，当前仅MaxCompute类型支持。', 'type' => 'boolean', 'example' => 'false'],
'BusinessMetadata' => [
'title' => '业务元数据',
'description' => '业务元数据。',
'type' => 'object',
'properties' => [
'Description' => ['title' => '字段业务描述', 'description' => '字段业务描述，当前仅MaxCompute，HMS（EMR集群），DLF类型支持。', 'type' => 'string', 'example' => '字段1的业务描述'],
'CustomAttributes' => [
'title' => '自定义属性值，key为自定义属性标识，value为属性值列表',
'description' => '自定义属性值，key为自定义属性标识，value为属性值列表',
'type' => 'object',
'additionalProperties' => [
'title' => '自定义属性值的数组，当前仅支持单值数组',
'description' => '属性值列表',
'type' => 'array',
'items' => ['title' => '自定义属性值', 'description' => '属性值', 'type' => 'string', 'example' => '张三'],
],
],
],
],
'StatisticsInfos' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
],
],
'CrawlerType' => [
'cloudType' => 'public',
'branchId' => 5146348,
'branchName' => 'master',
'paramExtraInfo' => [
'$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.Optional.description' => '实体类型是否可选'."\n"
."\n"
.'如对于maxcompute-schema类型，schema层级是否存在可选（是否开启三层模型）', '$.components.schemas.CrawlerType.description' => '元数据采集器类型', '$.components.schemas.CrawlerType.properties.DisplayName.description' => '展示名称', '$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.Optional.example' => 'true', '$.components.schemas.CrawlerType.properties.DisplayName.example' => 'Data Lake Formation', '$.components.schemas.CrawlerType.properties.Type.description' => '类型标识，当前支持的元数据采集器类型，取值有'."\n"
."\n"
.'- `maxcompute`'."\n"
.'- `dlf` '."\n"
.'- `hms`（使用HMS管理元数据的EMR集群或CDH_HIVE集群）'."\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` （仅支持查询Internal Catalog）', '$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.SubType.description' => '实体子类型标识，如`catalog/database/schema/table/column`', '$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.Type.description' => '实体类型标识，与采集器类型相关，格式为`${CrawlerType}-${SubType}`', '$.components.schemas.CrawlerType.properties.SupportedEntityTypes.description' => '支持的实体类型列表，实体类型之间按照声明顺序，具有自上而下的层级关系', '$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.SubType.example' => 'table',
'$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.ParentSubType.example' => 'database', '$.components.schemas.CrawlerType.properties.Type.example' => 'dlf', '$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.Type.example' => 'dlf-table', '$.components.schemas.CrawlerType.properties.SupportedEntityTypes.items.properties.ParentSubType.description' => '父层级的实体子类型，不存在时为null',
],
'title' => '元数据采集器类型',
'description' => '元数据采集器类型',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '类型标识', 'description' => '类型标识，当前支持的元数据采集器类型，取值有'."\n"
."\n"
.'- `maxcompute`'."\n"
.'- `dlf` （仅支持dlf1.0）'."\n"
.'- `hms`（使用HMS管理元数据的EMR集群或CDH_HIVE集群）'."\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` （仅支持查询Internal Catalog）', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf', 'backendName' => 'type'],
'DisplayName' => ['title' => '展示名称', 'description' => '展示名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Data Lake Formation', 'backendName' => 'displayName'],
'SupportedEntityTypes' => [
'title' => '支持的实体类型列表，实体类型之间按照声明顺序，具有自上而下的层级关系',
'description' => '支持的实体类型列表，实体类型之间按照声明顺序，具有自上而下的层级关系',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '实体类型标识，与采集器类型相关，格式为(CrawlerType)-{SubType}', 'description' => '实体类型标识，与采集器类型相关，格式为`${CrawlerType}-${SubType}`', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf-table', 'backendName' => 'type'],
'SubType' => ['title' => '实体子类型标识', 'description' => '实体子类型标识，如`catalog/database/schema/table/column`', 'visibility' => 'Public', 'type' => 'string', 'example' => 'table', 'backendName' => 'subType'],
'Optional' => ['title' => '实体类型是否可选', 'description' => '实体类型是否可选'."\n"
."\n"
.'如对于maxcompute-schema类型，schema层级是否存在可选（是否开启三层模型）', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'optional'],
'ParentSubType' => ['title' => '父层级的实体子类型，不存在时为null', 'description' => '父层级的实体子类型，不存在时为null', 'visibility' => 'Public', 'type' => 'string', 'example' => 'database', 'backendName' => 'parentSubType'],
],
'extendType' => 'true',
],
'backendName' => 'supportedEntityTypes',
],
],
],
'CustomAttribute' => [
'title' => '自定义属性定义',
'description' => '自定义属性定义',
'type' => 'object',
'properties' => [
'Id' => ['title' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'description' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'type' => 'string', 'example' => 'custom-attribute:biz_owner'],
'DisplayName' => ['title' => '自定义属性展示名称，长度小于128个字符', 'description' => '自定义属性展示名称，长度小于128个字符', 'type' => 'string', 'example' => '业务负责人'],
'Type' => [
'title' => '自定义属性类型，支持 ENUM、TEXT、HYPERLINK',
'description' => '自定义属性类型，支持 ENUM、TEXT、HYPERLINK',
'type' => 'string',
'example' => 'TEXT',
'enum' => ['ENUM', 'TEXT', 'HYPERLINK'],
],
'EntityTypes' => [
'title' => '适用实体类型列表，支持精确实体类型以及 `*-table`、`*-column` 通配写法',
'description' => '适用实体类型列表，支持精确实体类型以及 `*-table`、`*-column` 通配写法，如'."\n"
.'- dataworks-project'."\n"
.'- dataworks-dataset'."\n"
.'- maxcompute-table'."\n"
.'- maxcompute-column',
'type' => 'array',
'items' => ['description' => '实体类型', 'type' => 'string', 'example' => 'maxcompute-table'],
],
'ValueEnums' => [
'title' => '枚举可选值，type=ENUM时必填；TEXT、HYPERLINK类型不支持',
'description' => '枚举可选值，type=ENUM时必填；TEXT、HYPERLINK类型不支持',
'type' => 'array',
'items' => ['description' => '枚举值', 'type' => 'string', 'example' => 'VALUE_1'],
],
'SearchFilterEnabled' => ['title' => '是否支持作为筛选条件，默认为false', 'description' => '是否支持作为搜索页的筛选条件（只影响数据地图页面搜索），目前仅支持ENUM类型取值为true，默认为false', 'type' => 'boolean', 'example' => 'false'],
'DisplayEnabled' => ['title' => '是否在页面展示，默认为true', 'description' => '是否在页面展示，默认为true', 'type' => 'boolean', 'example' => 'true'],
'Comment' => ['title' => '自定义属性描述，长度小于256个字符', 'description' => '自定义属性描述，长度小于256个字符', 'type' => 'string', 'example' => 'this is a comment'],
'CreateTime' => ['title' => '创建时间，毫秒级时间戳', 'description' => '创建时间，毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1750817692000'],
'ModifyTime' => ['title' => '修改时间，毫秒级时间戳', 'description' => '修改时间，毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1763380628000'],
],
],
'Database' => [
'cloudType' => 'public',
'branchId' => 5125111,
'branchName' => 'master',
'paramExtraInfo' => [
'$.components.schemas.Database.properties.ModifyTime.description' => '更新时间（毫秒级时间戳）', '$.components.schemas.Database.properties.ParentMetaEntityId.description' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'父层级实体类型参考ListCrawlerTypes接口'."\n"
."\n"
.'- 若父层级实体为数据目录，`ParentMetaEntityId`格式参考`Catalog`对象'."\n"
.'- 如果父层级实体为元数据采集器，`ParentMetaEntityId`格式为`${CrawlerType}:${实例ID或转义后的URL}`'."\n"
."\n"
.'几种常用类型的ParentMetaEntityId格式参考如下'."\n"
."\n"
.'`dlf-catalog::catalog_id`'."\n"
."\n"
.'`holo:instance_id`'."\n"
."\n"
.'`mysql:(instance_id|encoded_jdbc_url)`'."\n"
."\n"
.'> 其中 '."\n"
.'`catalog_id`: dlf目录id '."\n"
.'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供', '$.components.schemas.Database.properties.Comment.description' => '注释', '$.components.schemas.Database.properties.ModifyTime.example' => '1736852168000', '$.components.schemas.Database.properties.CreateTime.example' => '1736852168000', '$.components.schemas.Database.properties.LocationUri.description' => '存储位置URI', '$.components.schemas.Database.properties.CreateTime.description' => '创建时间（毫秒级时间戳）', '$.components.schemas.Database.properties.Comment.example' => 'test comment', '$.components.schemas.Database.properties.ParentMetaEntityId.example' => 'dlf-catalog::catalog_id', '$.components.schemas.Database.properties.Id.example' => 'dlf-database::catalog_id:database_name',
'$.components.schemas.Database.properties.Name.description' => '名称', '$.components.schemas.Database.properties.Name.example' => 'database_name', '$.components.schemas.Database.description' => '数据库', '$.components.schemas.Database.properties.LocationUri.example' => 'oss://test-bucket/test_db', '$.components.schemas.Database.properties.Id.description' => '数据库实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级使用空字符占位'."\n"
."\n"
.'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n"
."\n"
.'几种常用类型的ID格式参考如下'."\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`: dlf目录id '."\n"
.'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`database_name`: 数据库名称',
],
'title' => '数据库',
'description' => '数据库',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => 'ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录名称}:${数据库名称}`，对于不存在的层级置空', 'visibility' => 'Public', 'type' => 'string', 'example' => 'holo-database:h-xxxx::test_db', 'backendName' => 'id'],
'Name' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_db', 'backendName' => 'name'],
'Comment' => ['title' => '注释', 'description' => '注释', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test comment', 'backendName' => 'comment'],
'LocationUri' => ['title' => '存储位置URI', 'description' => '存储位置URI', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://test-bucket/test_db', 'backendName' => 'locationUri'],
'ParentMetaEntityId' => ['title' => '父层级元数据实体ID', 'description' => '父层级实体ID，父层级实体类型参考ListCrawlerTypes接口'."\n"
."\n"
.'- 如果父层级实体为数据目录，此处为数据目录ID'."\n"
."\n"
.'- 如果父层级实体为元数据采集器实例，ID格式为`${CrawlerType}:${实例ID或转义后的URL}`', 'visibility' => 'Public', 'type' => 'string', 'example' => 'holo:h-xxxx', 'backendName' => 'parentMetaEntityId'],
'CreateTime' => ['title' => '创建时间（毫秒级时间戳）', 'description' => '创建时间（毫秒级时间戳）', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'createTime'],
'ModifyTime' => ['title' => '更新时间（毫秒级时间戳）', 'description' => '更新时间（毫秒级时间戳）', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'modifyTime'],
],
],
'DataQualityEvaluationTask' => [
'title' => 'A short description of struct',
'description' => '质量监控任务',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '数据质量校验任务ID', 'description' => '数据质量校验任务ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'],
'Name' => ['title' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => '质量校验任务', 'backendName' => 'name'],
'Description' => ['title' => '数据质量校验任务描述，最长65535个字符', 'description' => '数据质量校验任务描述，最长65535个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => 'This is a daily run data quality evaluation plan.', 'backendName' => 'description'],
'TenantId' => ['title' => 'DataWorks租户ID', 'description' => 'DataWorks租户ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'backendName' => 'tenantId'],
'ProjectId' => ['title' => 'Dataworks项目空间ID', 'description' => 'Dataworks项目空间ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'backendName' => 'projectId'],
'Target' => [
'title' => '数据质量校验任务的监控对象',
'description' => '数据质量校验任务的监控对象',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '监控对象类型', 'description' => '监控对象类型'."\n"
.'- Table', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'],
'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'],
'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => '分区表的分区设置', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'],
],
'backendName' => 'target',
],
'Trigger' => [
'title' => '数据质量校验任务的触发配置',
'description' => '数据质量校验任务的触发配置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '何种事件可以触发质量校验任务执行', 'description' => '何种事件可以触发质量校验任务执行'."\n"
.'- ByScheduledTaskInstance：调度实例运行成功', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ByScheduledTaskInstance', 'backendName' => 'type'],
'TaskIds' => [
'title' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发',
'description' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '调度任务节点ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'extendType' => 'true'],
'backendName' => 'taskIds',
],
],
'backendName' => 'trigger',
],
'DataSourceId' => ['title' => '数据质量校验任务执行时应使用的数据源', 'description' => '数据质量校验任务执行时应使用的数据源', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'backendName' => 'dataSourceId'],
'RuntimeConf' => ['title' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', 'backendName' => 'runtimeConf'],
'Hooks' => [
'title' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook',
'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '后续处理动作类型，如BLOCK_TASK_INSTANCE：阻塞DataWorks任务实例执行', 'description' => '后续处理动作类型'."\n"
.'- BlockTaskInstance：阻塞DataWorks任务实例执行', 'visibility' => 'Public', 'type' => 'string', 'example' => 'BlockTaskInstance', 'backendName' => 'type'],
'Condition' => ['title' => 'Hook触发条件', 'description' => 'Hook触发条件', 'visibility' => 'Public', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"', 'backendName' => 'condition'],
],
'extendType' => 'true',
],
'backendName' => 'hooks',
],
'Notifications' => [
'title' => '数据质量校验任务通知订阅配置',
'description' => '数据质量校验任务通知订阅配置',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Condition' => ['title' => '告警触发条件', 'description' => '告警触发条件', 'visibility' => 'Public', 'type' => 'string', 'example' => '${blockType} == "Strong"', 'backendName' => 'condition'],
'Notifications' => [
'title' => '具体的消息通知设置',
'description' => '具体的消息通知设置',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '告警方式',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'NotificationChannels' => [
'title' => '告警方式',
'description' => '告警方式',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Channels' => [
'title' => '告警方式',
'description' => '告警方式',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '- Mail - 邮件'."\n"
.'- Sms - 短信'."\n"
.'- Phone - 电话'."\n"
.'- Feishu - 飞书'."\n"
.'- Weixin - 微信'."\n"
.'- Dingding - 钉钉'."\n"
.'- Webhook - 自定义Webhook', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Mail', 'extendType' => 'true'],
'example' => 'Mail',
'backendName' => 'channels',
],
],
'extendType' => 'true',
],
'backendName' => 'notificationChannels',
],
'NotificationReceivers' => [
'title' => '告警接收人设置',
'description' => '告警接收人设置',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'ReceiverType' => ['title' => '告警接收人类型', 'description' => '告警接收人类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'AliUid', 'backendName' => 'receiverType'],
'ReceiverValues' => [
'title' => '告警接收人具体值',
'description' => '告警接收人具体值',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '告警接收人具体值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user1', 'extendType' => 'true'],
'backendName' => 'receiverValues',
],
'Extension' => ['title' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"atAll":"true"}', 'backendName' => 'extension'],
],
'extendType' => 'true',
],
'backendName' => 'notificationReceivers',
],
],
'extendType' => 'true',
],
'backendName' => 'notifications',
],
],
'extendType' => 'true',
],
'backendName' => 'notifications',
],
],
],
'DataQualityEvaluationTaskInstance' => [
'title' => 'A short description of struct',
'description' => '质量监控任务实例',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '任务实例ID', 'description' => '任务实例ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'],
'CreateTime' => ['title' => '任务实例创建时间', 'description' => '任务实例创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'backendName' => 'createTime'],
'FinishTime' => ['title' => '任务实例结束时间', 'description' => '任务实例结束时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'backendName' => 'finishTime'],
'Status' => ['title' => '当前运行状态', 'description' => '当前运行状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Passed', 'backendName' => 'status'],
'Task' => [
'title' => '校验开始时，数据质量校验任务的快照',
'description' => '校验开始时，数据质量校验任务的快照',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '数据质量校验任务ID', 'description' => '数据质量校验任务ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'],
'Name' => ['title' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => '质量校验任务', 'backendName' => 'name'],
'TenantId' => ['title' => 'DataWorks租户ID', 'description' => 'DataWorks租户ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '195820716552192', 'backendName' => 'tenantId'],
'ProjectId' => ['title' => 'DataWorks项目空间ID', 'description' => 'DataWorks项目空间ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2626', 'backendName' => 'projectId'],
'Target' => [
'title' => '数据质量校验任务的监控对象',
'description' => '数据质量校验任务的监控对象',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '监控对象类型', 'description' => '监控对象类型'."\n"
."\n"
.'- Table', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'],
'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'],
'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => '分区表的分区设置', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'],
],
'backendName' => 'target',
],
'Trigger' => [
'title' => '数据质量校验任务的触发配置',
'description' => '数据质量校验任务的触发配置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '何种事件可以触发质量校验任务执行', 'description' => '何种事件可以触发质量校验任务执行'."\n"
.'- ByScheduledTaskInstance：调度实例运行成功', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ByScheduledTaskInstance', 'backendName' => 'type'],
'TaskIds' => [
'title' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发',
'description' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '调度任务节点ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'extendType' => 'true'],
'backendName' => 'taskIds',
],
],
'backendName' => 'trigger',
],
'DataSourceId' => ['title' => '数据质量校验任务执行时应使用的数据源', 'description' => '数据质量校验任务执行时应使用的数据源', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'backendName' => 'dataSourceId'],
'RuntimeConf' => ['title' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', 'backendName' => 'runtimeConf'],
'Hooks' => [
'title' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook',
'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '回调设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '后续处理动作类型', 'description' => '后续处理动作类型'."\n"
.'- BlockTaskInstance：阻塞DataWorks任务实例执行', 'visibility' => 'Public', 'type' => 'string', 'example' => 'BlockTaskInstance', 'backendName' => 'type'],
'Condition' => ['title' => 'Hook触发条件', 'description' => 'Hook触发条件', 'visibility' => 'Public', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"', 'backendName' => 'condition'],
],
'extendType' => 'true',
],
'backendName' => 'hooks',
],
'Notifications' => [
'title' => '数据质量校验任务告警订阅配置',
'description' => '数据质量校验任务告警订阅配置',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '告警设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Condition' => ['title' => '告警触发条件', 'description' => '告警触发条件', 'visibility' => 'Public', 'type' => 'string', 'example' => '${blockType} == "Strong"', 'backendName' => 'condition'],
'Notifications' => [
'title' => '具体的消息通知设置',
'description' => '具体的消息通知设置',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'NotificationChannels' => [
'title' => '告警方式',
'description' => '告警方式',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Channels' => [
'title' => '告警方式',
'description' => '告警方式',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '- Mail - 邮件'."\n"
.'- Sms - 短信'."\n"
.'- Phone - 电话'."\n"
.'- Feishu - 飞书'."\n"
.'- Weixin - 微信'."\n"
.'- Dingding - 钉钉'."\n"
.'- Webhook - 自定义Webhook', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Mail', 'extendType' => 'true'],
'example' => 'Mail',
'backendName' => 'channels',
],
],
'example' => 'Dingding',
'extendType' => 'true',
],
'backendName' => 'notificationChannels',
],
'NotificationReceivers' => [
'title' => '告警接收人配置',
'description' => '告警接收人配置',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'ReceiverType' => ['title' => '告警接收人配置', 'description' => '告警接收人配置', 'visibility' => 'Public', 'type' => 'string', 'example' => 'AliUid', 'backendName' => 'receiverType'],
'ReceiverValues' => [
'title' => '告警接收人具体值',
'description' => '告警接收人具体值',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '告警接收人具体值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'user1', 'extendType' => 'true'],
'backendName' => 'receiverValues',
],
'Extension' => ['title' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'visibility' => 'Public', 'type' => 'string', 'example' => '{"atAll":"true"}', 'backendName' => 'extension'],
],
'extendType' => 'true',
],
'backendName' => 'notificationReceivers',
],
],
'extendType' => 'true',
],
'backendName' => 'notifications',
],
],
'extendType' => 'true',
],
'backendName' => 'notifications',
],
],
'backendName' => 'task',
],
],
],
'DataQualityResult' => [
'title' => 'A short description of struct',
'description' => '数据质量结果',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '校验结果ID', 'description' => '校验结果ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'],
'Status' => ['title' => '校验结果状态', 'description' => '校验结果状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Passed', 'backendName' => 'status'],
'TaskInstanceId' => ['title' => '质量校验任务实例ID', 'description' => '质量校验任务实例ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '20001', 'backendName' => 'taskInstanceId'],
'Rule' => [
'title' => '校验开始时，规则配置快照',
'description' => '校验开始时，规则配置快照',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '规则ID，全局唯一标识', 'description' => '规则ID，全局唯一标识', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'backendName' => 'id'],
'Name' => ['title' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => '表不能为空', 'backendName' => 'name'],
'TenantId' => ['title' => 'DataWorks租户ID', 'description' => 'DataWorks租户ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'tenantId'],
'ProjectId' => ['title' => 'DataWorks项目空间ID', 'description' => 'DataWorks项目空间ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'backendName' => 'projectId'],
'Enabled' => ['title' => '规则是否启用', 'description' => '规则是否启用', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled'],
'Severity' => ['title' => '规则对于业务的等级（对应页面上的强弱规则）', 'description' => '规则对于业务的等级（对应页面上的强弱规则）', 'visibility' => 'Public', 'type' => 'string', 'example' => 'High', 'backendName' => 'severity'],
'Description' => ['title' => '规则描述信息，最长500个字符', 'description' => '规则描述信息，最长500个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => 'this is a odps _sql task', 'backendName' => 'description'],
'Target' => [
'title' => '规则所监控的对象',
'description' => '规则所监控的对象',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '监控对象类型', 'description' => '监控对象类型'."\n"
.'- Table', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'],
'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'],
'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => '分区表的分区设置', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'],
],
'backendName' => 'target',
],
'TemplateCode' => ['title' => 'system::user创建规则时所引用的规则模板', 'description' => '创建规则时所引用的规则模板', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SYSTEM:user_defined_sql', 'backendName' => 'templateCode'],
'SamplingConfig' => [
'title' => '样本采集所需的设置',
'description' => '样本采集所需的设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Metric' => ['title' => '采样的指标名称', 'description' => '采样的指标名称'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Min', 'backendName' => 'metric'],
'MetricParameters' => ['title' => '样本采集时，所需的参数', 'description' => '样本采集时，所需的参数', 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] }', 'backendName' => 'metricParameters'],
'SettingConfig' => ['title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s;', 'backendName' => 'settingConfig'],
'SamplingFilter' => ['title' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => 'id IS NULL', 'backendName' => 'samplingFilter'],
],
'backendName' => 'samplingConfig',
],
'CheckingConfig' => [
'title' => '样本校验设置',
'description' => '样本校验设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '阈值计算方式', 'description' => '阈值计算方式'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Fixed', 'backendName' => 'type'],
'ReferencedSamplesFilter' => ['title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'backendName' => 'referencedSamplesFilter'],
'Thresholds' => [
'title' => '阈值设置',
'description' => '阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Expected' => [
'title' => '期望的阈值设置',
'description' => '期望的阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Value' => ['title' => '阈值数值', 'description' => '阈值数值', 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'],
'Operator' => ['title' => '比较符', 'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'],
],
'backendName' => 'expected',
],
'Warned' => [
'title' => '普通警告的阈值设置',
'description' => '普通警告的阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Value' => ['title' => '阈值数值', 'description' => '阈值数值', 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'],
'Operator' => ['title' => '比较符', 'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'],
],
'backendName' => 'warned',
],
'Critical' => [
'title' => '严重警告的阈值设置',
'description' => '严重警告的阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Value' => ['title' => '阈值数值', 'description' => '阈值数值', 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'],
'Operator' => ['title' => '比较符', 'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'],
],
'backendName' => 'critical',
],
],
'backendName' => 'thresholds',
],
],
'backendName' => 'checkingConfig',
],
'ErrorHandlers' => [
'title' => '质量规则校验问题处理器',
'description' => '质量规则校验问题处理器',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '质量规则校验问题处理器',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '处理器类型', 'description' => '处理器类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SaveErrorData', 'backendName' => 'type'],
'ErrorDataFilter' => ['title' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', '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' => '本次校验所使用的样本值', 'visibility' => 'Public', 'type' => 'string', 'example' => '[ { "gender": "male", "_count": 100 }, { "gender": "female", "_count": 100 } ]', 'backendName' => 'sample'],
'Details' => [
'title' => '本次校验的详情',
'description' => '本次校验的详情',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '校验详情',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'ReferencedValue' => ['title' => '使用引用的样本，用来参与CheckedValue计算的基准值', 'description' => '使用引用的样本，用来参与CheckedValue计算的基准值', 'visibility' => 'Public', 'type' => 'string', 'example' => '0.0', 'backendName' => 'referencedValue'],
'CheckedValue' => ['title' => '最终用来与阈值比较的值', 'description' => '最终用来与阈值比较的值', 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'checkedValue'],
'Status' => ['title' => '最终的比较结果状态', 'description' => '最终的比较结果状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Passed', 'backendName' => 'status'],
],
'extendType' => 'true',
],
'backendName' => 'details',
],
],
],
'DataQualityRule' => [
'title' => 'A short description of struct',
'description' => '数据质量规则',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '规则ID', 'description' => '规则ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'backendName' => 'id'],
'Name' => ['title' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => '表不能为空', 'backendName' => 'name'],
'TenantId' => ['title' => 'Dataworks租户ID', 'description' => 'Dataworks租户ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'tenantId'],
'ProjectId' => ['title' => 'Dataworks项目空间ID', 'description' => 'Dataworks项目空间ID', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'backendName' => 'projectId'],
'Enabled' => ['title' => '规则是否启用', 'description' => '规则是否启用', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled'],
'Severity' => ['title' => '规则对于业务的等级（对应页面上的强弱规则）', 'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n"
.'- Normal'."\n"
.'- High', 'visibility' => 'Public', 'type' => 'string', 'example' => 'High', 'backendName' => 'severity'],
'Description' => ['title' => '规则描述信息，最长500个字符', 'description' => '规则描述信息，最长500个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => 'this is a odps _sql task', 'backendName' => 'description'],
'TemplateCode' => ['title' => '创建规则时所引用的规则模板', 'description' => '创建规则时所引用的规则模板', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SYSTEM:user_defined_sql', 'backendName' => 'templateCode'],
'Target' => [
'title' => '规则所监控的对象',
'description' => '规则所监控的对象',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '监控对象类型', 'description' => '监控对象类型'."\n"
.'- Table', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'],
'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'],
'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => '分区表的分区设置', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'],
],
'backendName' => 'target',
],
'SamplingConfig' => [
'title' => '样本采集所需的设置',
'description' => '样本采集所需的设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Metric' => ['title' => '采样的指标名称', 'description' => '采样的指标名称'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Min', 'backendName' => 'metric'],
'MetricParameters' => ['title' => '样本采集时，所需的参数', 'description' => '样本采集时，所需的参数', 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] }', 'backendName' => 'metricParameters'],
'SettingConfig' => ['title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s;', 'backendName' => 'settingConfig'],
'SamplingFilter' => ['title' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'visibility' => 'Public', 'type' => 'string', 'example' => 'id IS NULL', 'backendName' => 'samplingFilter'],
],
'backendName' => 'samplingConfig',
],
'CheckingConfig' => [
'title' => '样本校验设置',
'description' => '样本校验设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '阈值计算方式', 'description' => '阈值计算方式'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Fixed', 'backendName' => 'type'],
'ReferencedSamplesFilter' => ['title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'backendName' => 'referencedSamplesFilter'],
'Thresholds' => [
'title' => '阈值设置',
'description' => '阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Expected' => [
'title' => '期望的阈值设置',
'description' => '期望的阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Value' => ['title' => '阈值数值', 'description' => '阈值数值', 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'],
'Operator' => ['title' => '比较符', 'description' => '比较符'."\n"
.'- />'."\n"
.'- />='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'],
'Expression' => ['title' => '阈值表达式', 'description' => '阈值表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', 'backendName' => 'expression'],
],
'backendName' => 'expected',
],
'Warned' => [
'title' => '普通警告的阈值设置',
'description' => '普通警告的阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Value' => ['title' => '阈值数值', 'description' => '阈值数值', 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'],
'Operator' => ['title' => '比较符', 'description' => '比较符'."\n"
.'- />'."\n"
.'- />='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'],
'Expression' => ['title' => '阈值表达式', 'description' => '阈值表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', 'backendName' => 'expression'],
],
'backendName' => 'warned',
],
'Critical' => [
'title' => '严重警告的阈值设置',
'description' => '严重警告的阈值设置',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Value' => ['title' => '阈值数值', 'description' => '阈值数值', 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'],
'Operator' => ['title' => '比较符', 'description' => '比较符'."\n"
.'- />'."\n"
.'- />='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'],
'Expression' => ['title' => '校验表达式', 'description' => '校验表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', 'backendName' => 'expression'],
],
'backendName' => 'critical',
],
],
'backendName' => 'thresholds',
],
],
'backendName' => 'checkingConfig',
],
'ErrorHandlers' => [
'title' => '质量规则校验问题处理器',
'description' => '质量规则校验问题处理器',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => ['title' => '处理器类型', 'description' => '处理器类型：'."\n"
."\n"
.'- SaveErrorData', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SaveErrorData', 'backendName' => 'type'],
'ErrorDataFilter' => ['title' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', 'description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', 'backendName' => 'errorDataFilter'],
],
'extendType' => 'true',
],
'backendName' => 'errorHandlers',
],
],
],
'DataQualityRuleTemplate' => [
'title' => '质量规则模版',
'description' => '质量规则模版',
'type' => 'object',
'properties' => [
'Code' => ['title' => '规则模板Code，全局唯一标识', 'type' => 'string', 'backendName' => 'code'],
'Name' => ['title' => '规则模板名称', 'type' => 'string', 'backendName' => 'name'],
'TenantId' => ['title' => 'DataWorks租户ID', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'tenantId'],
'ProjectId' => ['title' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'projectId'],
'SamplingConfig' => [
'title' => '样本采集设置',
'type' => 'object',
'properties' => [
'Metric' => ['title' => '采样的指标名称', 'type' => 'string', 'example' => 'Min', 'backendName' => 'metric'],
'MetricParameters' => ['title' => '样本采集时，所需的参数', 'type' => 'string', 'example' => '{ "SQL": "SELECT min(id) from table;" }', 'backendName' => 'metricParameters'],
'SettingConfig' => ['title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s;', 'backendName' => 'settingConfig'],
],
'backendName' => 'samplingConfig',
],
'CheckingConfig' => [
'title' => '样本校验设置',
'type' => 'object',
'properties' => [
'Type' => ['title' => '阈值计算方式', 'type' => 'string', 'example' => 'Fixed', 'backendName' => 'type'],
'ReferencedSamplesFilter' => ['title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'backendName' => 'referencedSamplesFilter'],
],
'backendName' => 'checkingConfig',
],
'VisibleScope' => ['title' => '模板的可用范围', 'type' => 'string', 'example' => 'Project', 'backendName' => 'visibleScope'],
'DirectoryPath' => ['title' => '自定义模板被存放的类目目录，斜线分隔层级', 'type' => 'string', 'example' => '/ods/订单数据', 'backendName' => 'directoryPath'],
],
],
'Dataset' => [
'title' => '数据集对象',
'description' => '数据集对象',
'type' => 'object',
'properties' => [
'Id' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'string', 'example' => 'dataworks-dataset:1gxxxqjx155usz3hrv'],
'Name' => ['title' => '数据集名称，非空字符串，长度小于128', 'description' => '数据集名称，非空字符串，长度小于128', 'type' => 'string', 'example' => 'test_dataset'],
'Comment' => ['title' => '数据集描述，长度小于1024', 'description' => '数据集描述，长度小于1024', 'type' => 'string', 'example' => '测试数据集'],
'ProjectId' => ['title' => 'DataWorks工作空间ID', 'description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'Origin' => ['title' => '数据集来源，当前支持'."\n"
.'- DataWorks'."\n"
.'- PAI', 'description' => '数据集来源，当前支持'."\n"
.'- DataWorks'."\n"
.'- PAI', 'type' => 'string', 'example' => 'DataWorks'],
'DataType' => [
'title' => '数据类型，取值有'."\n"
.'- COMMON 通用'."\n"
.'- PIC 图片'."\n"
.'- TEXT 文本'."\n"
.'- TABLE 表格'."\n"
.'- VIDEO 视频'."\n"
.'- AUDIO 音频'."\n"
.'- INDEX 索引',
'description' => '数据类型，取值有'."\n"
.'- COMMON 通用'."\n"
.'- PIC 图片'."\n"
.'- TEXT 文本'."\n"
.'- TABLE 表格'."\n"
.'- VIDEO 视频'."\n"
.'- AUDIO 音频'."\n"
.'- INDEX 索引',
'type' => 'string',
'enumValueTitles' => ['TABLE' => '表格', 'VIDEO' => '视频', 'COMMON' => '通用', 'TEXT' => '文本', 'PIC' => '图片', 'INDEX' => '索引', 'AUDIO' => '音频'],
'example' => 'COMMON',
],
'StorageType' => [
'title' => '存储类型，取值有'."\n"
.'- OSS 对象存储'."\n"
.'- NAS 通用型NAS文件存储'."\n"
.'- EXTREM_NAS 极速型NAS文件存储'."\n"
.'- DLF_LANCE 数据湖构建'."\n"
.'- CPFS CPFS文件存储'."\n"
.'- BMCPFS 智算CPFS文件存储'."\n"
.'- MAXCOMPUTE MaxCompute表',
'description' => '存储类型，取值有'."\n"
.'- OSS 对象存储'."\n"
.'- NAS 通用型NAS文件存储'."\n"
.'- EXTREM_NAS 极速型NAS文件存储'."\n"
.'- DLF_LANCE 数据湖构建'."\n"
.'- CPFS CPFS文件存储'."\n"
.'- BMCPFS 智算CPFS文件存储'."\n"
.'- MAXCOMPUTE MaxCompute表',
'type' => 'string',
'enumValueTitles' => ['NAS' => '通用型NAS文件存储', 'MAXCOMPUTE' => 'MaxCompute表', 'CPFS' => 'CPFS文件存储', 'BMCPFS' => '智算CPFS文件存储', 'EXTREMENAS' => '极速型NAS文件存储', 'OSS' => '对象存储', 'DLF_LANCE' => '数据湖构建'],
'example' => 'OSS',
],
'CreatorId' => ['title' => '创建者ID', 'description' => '创建者ID', 'type' => 'string', 'example' => '210484359'],
'Readme' => ['title' => '数据集使用说明，支持markdown富文本', 'description' => '数据集使用说明，支持markdown富文本', 'type' => 'string', 'example' => '## introduction'],
'LatestVersion' => ['title' => '最新数据集版本对象', 'description' => '最新数据集版本对象', '$ref' => '#/components/schemas/DatasetVersion'],
'CreateTime' => ['title' => '创建时间毫秒级时间戳', 'description' => '创建时间毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1736756055000'],
'ModifyTime' => ['title' => '修改时间毫秒级时间戳', 'description' => '修改时间毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1736756055000'],
'Labels' => [
'title' => '数据集标签，目前仅PAI数据集支持',
'description' => '数据集标签，目前仅PAI数据集支持',
'type' => 'array',
'items' => ['description' => 'PAI数据集标签对象', '$ref' => '#/components/schemas/DatasetLabel'],
],
],
],
'DatasetLabel' => [
'title' => 'PAI数据集标签',
'description' => 'PAI数据集标签',
'type' => 'object',
'properties' => [
'Key' => ['title' => '数据集标签键', 'description' => '数据集标签键', 'type' => 'string', 'example' => 'key1'],
'Value' => ['title' => '数据集标签值', 'description' => '数据集标签值', 'type' => 'string', 'example' => 'value1'],
],
],
'DatasetVersion' => [
'title' => '数据集版本对象',
'description' => '数据集版本对象',
'type' => 'object',
'properties' => [
'Id' => ['title' => '数据集版本ID', 'description' => '数据集版本ID', 'type' => 'string', 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv:1'],
'DatasetId' => ['title' => '对应数据集ID', 'description' => '对应数据集ID', 'type' => 'string', 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv'],
'Comment' => ['title' => '版本使用说明', 'description' => '数据集版本描述', 'type' => 'string', 'example' => '初始版本'],
'CreatorId' => ['title' => '创建者ID', 'description' => '创建者ID', 'type' => 'string', 'example' => '17815XXX61016173'],
'VersionNumber' => ['title' => '数据集版本号', 'description' => '数据集版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'StorageType' => ['title' => '存储类型，只读，与所属数据集对应属性保持一致', 'description' => '存储类型，只读，与所属数据集对应属性保持一致', 'type' => 'string', 'example' => 'OSS'],
'Url' => ['title' => 'URL地址', 'description' => 'URL地址', 'type' => 'string', 'example' => 'oss://test-oss-bucket/test_dir/'],
'MountPath' => ['title' => '挂载路径，默认为 /mnt/data', 'description' => '挂载路径，默认为 /mnt/data', 'type' => 'string', 'example' => '/mnt/data'],
'CreateTime' => ['title' => '创建时间毫秒级时间戳', 'description' => '创建时间毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1736756055000'],
'ModifyTime' => ['title' => '修改时间毫秒级时间戳', 'description' => '修改时间毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1736756055000'],
'Labels' => [
'title' => 'PAI数据集标签',
'description' => 'PAI数据集标签',
'type' => 'array',
'items' => ['description' => 'PAI数据集标签', '$ref' => '#/components/schemas/DatasetLabel'],
],
'ImportInfo' => [
'title' => '数据集的存储导入配置'."\n"
.'对于NAS类型，需要提供以下属性，取值可参考DescribeFileSystems接口的返回信息'."\n"
.'- fileSystemId 文件系统ID'."\n"
.'- fileSystemStorageType 文件系统的存储规格'."\n"
.'- vpcId 挂载点的 VPC ID',
'description' => '数据集的存储导入配置, 对于不同存储类型，需要的配置信息不同'."\n"
.''."\n"
.'NAS
'."\n"
.'取值可参考文件存储 API DescribeFileSystems 的返回信息'."\n"
."\n"
.'```JSON'."\n"
.'{'."\n"
.' "fileSystemId": "3b6XXX89c9", // 文件系统ID'."\n"
.' "fileSystemStorageType": "Performance", // 文件系统的存储规格'."\n"
.' "vpcId": "vpc-uf66oxxxrqge1t2gson7s" // 挂载点的VPC ID'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.' ',
'type' => 'object',
'additionalProperties' => ['description' => '数据集的存储导入配置信息', 'type' => 'string', 'example' => 'None'],
],
],
],
'IdentifyCredential' => [
'description' => '身份凭证对象',
'type' => 'object',
'properties' => [
'UserId' => ['description' => '用户uid,如果是角色需要再前面添加 ROLE_ 前缀', 'type' => 'string', 'required' => false, 'example' => 'ROLE_300888674340307309'],
'UserType' => [
'description' => '- 主账号 PrimaryAccount'."\n"
.'- 子账号 SubAccount'."\n"
.'- 角色 Role',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Role' => '角色', 'PrimaryAccount' => '主账号', 'SubAccount' => '子账号'],
'example' => ' primaryAccount',
],
'ProjectId' => ['description' => '空间id，非必选', 'type' => 'string', 'example' => '10000'],
'DataSource' => [
'description' => '数据源',
'type' => 'object',
'properties' => [
'Type' => ['description' => '数据源类型，支持的类型'."\n"
.'- hive'."\n"
.'- lindorm_for_engine'."\n"
.'- starrocks', 'type' => 'string', 'required' => false, 'example' => 'hologres'],
'Role' => [
'description' => '数据源用户类型'."\n"
.'- Admin'."\n"
.'- RegularUser',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RegularUser' => '普通用户', 'Admin' => '管理员'],
'example' => 'admin',
],
'UserName' => ['description' => '数据源用户名', 'type' => 'string', 'required' => false, 'example' => 'tom'],
'Password' => ['description' => '数据源密码', 'type' => 'string', 'required' => false, 'example' => '***'],
'InstanceId' => ['description' => '数据源实例id', 'type' => 'string', 'required' => false, 'example' => '710007423244'],
'InstanceName' => ['description' => '数据源实例名称', 'type' => 'string', 'required' => false, 'example' => 'rm-2zez82ho69yex7s7g'],
],
],
],
],
'LineageEntity' => [
'cloudType' => 'public',
'branchId' => 5126472,
'branchName' => 'master',
'paramExtraInfo' => ['$.components.schemas.LineageEntity.properties.Id.description' => '实体ID', '$.components.schemas.LineageEntity.properties.Attributes.additionalProperties.description' => '属性', '$.components.schemas.LineageEntity.properties.Attributes.description' => '其他属性', '$.components.schemas.LineageEntity.properties.Attributes.example' => '{"key1":"value1"}', '$.components.schemas.LineageEntity.properties.Id.example' => 'maxcompute-table:::project_name:[schema_name]:table_name', '$.components.schemas.LineageEntity.properties.Name.description' => '名称', '$.components.schemas.LineageEntity.properties.Attributes.additionalProperties.example' => 'value', '$.components.schemas.LineageEntity.properties.Name.example' => 'test_tbl', '$.components.schemas.LineageEntity.description' => '血缘实体'],
'title' => '血缘实体',
'description' => '血缘实体',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '实体ID', 'description' => '实体ID', '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' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_tbl', 'backendName' => 'name'],
'Attributes' => [
'title' => '其他属性',
'description' => '其他属性',
'visibility' => 'Public',
'type' => 'object',
'additionalProperties' => ['description' => '属性', 'visibility' => 'Public', 'type' => 'string', 'example' => 'key1:value1'],
'example' => '{"key1":"value1"}',
'backendName' => 'attributes',
],
],
],
'LineageRelationship' => [
'cloudType' => 'public',
'branchId' => 5128654,
'branchName' => 'master',
'paramExtraInfo' => ['$.components.schemas.LineageRelationship.properties.SrcEntity.description' => '源实体', '$.components.schemas.LineageRelationship.description' => '血缘关系', '$.components.schemas.LineageRelationship.properties.Task.description' => '任务', '$.components.schemas.LineageRelationship.properties.Id.example' => 'as78d756asd', '$.components.schemas.LineageRelationship.properties.CreateTime.example' => '1743040581000', '$.components.schemas.LineageRelationship.properties.Id.description' => 'ID', '$.components.schemas.LineageRelationship.properties.DstEntity.description' => '目标实体', '$.components.schemas.LineageRelationship.properties.CreateTime.description' => '创建时间'],
'title' => '血缘关系',
'description' => '血缘关系',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'SrcEntity' => ['title' => '源实体', 'description' => '源实体', 'visibility' => 'Public', 'backendName' => 'srcEntity', '$ref' => '#/components/schemas/LineageEntity'],
'DstEntity' => ['title' => '目标实体', 'description' => '目标实体', 'visibility' => 'Public', 'backendName' => 'dstEntity', '$ref' => '#/components/schemas/LineageEntity'],
'Task' => ['title' => '任务', 'description' => '任务', 'visibility' => 'Public', 'backendName' => 'task', '$ref' => '#/components/schemas/LineageTask'],
'Id' => ['title' => 'ID', 'description' => 'ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-table.p.table:custom-table.xxx:custom-sql.123', 'backendName' => 'id'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1743040581000', 'backendName' => 'createTime'],
],
],
'LineageTask' => [
'cloudType' => 'public',
'branchId' => 5169184,
'branchName' => 'master',
'paramExtraInfo' => ['$.components.schemas.LineageTask.properties.Attributes.additionalProperties.example' => 'value', '$.components.schemas.LineageTask.properties.Type.description' => '任务类型', '$.components.schemas.LineageTask.properties.Id.example' => '12345', '$.components.schemas.LineageTask.properties.Id.description' => '任务ID', '$.components.schemas.LineageTask.properties.Attributes.description' => '任务属性', '$.components.schemas.LineageTask.properties.Attributes.additionalProperties.description' => '属性', '$.components.schemas.LineageTask.properties.Type.example' => 'custom-sql', '$.components.schemas.LineageTask.description' => '任务信息'],
'title' => '任务信息',
'description' => '任务信息',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => '任务ID', 'description' => '任务ID', 'visibility' => 'Public', 'type' => 'string', 'example' => '12345', 'backendName' => 'id'],
'Type' => ['title' => '任务类型', 'description' => '任务类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'custom-sql', 'backendName' => 'type'],
'Attributes' => [
'title' => '任务属性',
'description' => '任务属性',
'visibility' => 'Public',
'type' => 'object',
'additionalProperties' => ['description' => '属性', 'visibility' => 'Public', 'type' => 'string', 'example' => 'key1:value21'],
'backendName' => 'attributes',
],
],
],
'MetaEntity' => [
'title' => '自定义实体',
'description' => '自定义实体',
'type' => 'object',
'properties' => [
'Id' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'example' => 'custom_entity-customer_api:api_001'],
'EntityType' => ['title' => '实体类型', 'description' => '实体类型', 'type' => 'string', 'example' => 'custom_entity-customer_api'],
'Name' => ['title' => '实体名称', 'description' => '实体名称', 'type' => 'string', 'example' => 'api_001'],
'Comment' => ['title' => '注释', 'description' => '注释', 'type' => 'string', 'example' => 'this is a comment'],
'OwnerId' => ['title' => '负责人ID', 'description' => '负责人ID，默认为创建者阿里云UID', 'type' => 'string', 'example' => '207924799988354'],
'CustomAttributes' => [
'title' => '自定义属性值，key为自定义属性标识，value为属性值列表',
'description' => '自定义属性值，key为自定义属性标识，value为属性值列表',
'type' => 'object',
'additionalProperties' => [
'title' => '自定义属性值的数组，当前仅支持单值数组',
'description' => '属性值列表',
'type' => 'array',
'items' => ['title' => '自定义属性值', 'description' => '属性值', 'type' => 'string', 'example' => '张三'],
],
],
'MetaEntityDef' => ['title' => '实体类型定义，仅内部查询场景返回', 'description' => '自定义实体的属性定义'."\n"
.'历史原因该属性不返回，值为空，建议通过GetMetaEntityDef API 获取实体类型定义', '$ref' => '#/components/schemas/MetaEntityDef'],
'CreateTime' => ['title' => '创建时间，毫秒级时间戳', 'description' => '创建时间，毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1780553640613'],
'ModifyTime' => ['title' => '修改时间，毫秒级时间戳', 'description' => '修改时间，毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1763380628000'],
'Attributes' => [
'title' => '实体属性，复杂值以JSON字符串表示',
'description' => '实体属性，复杂值以JSON字符串表示',
'type' => 'object',
'additionalProperties' => ['description' => '实体属性值，如果为复杂类型，以JSON字符串表示', 'type' => 'string', 'example' => 'v1'],
],
],
],
'MetaEntityAttributeDef' => [
'title' => '自定义实体属性定义',
'description' => '自定义实体属性定义',
'type' => 'object',
'properties' => [
'Name' => ['title' => '属性标识，支持大小写字母、数字、下划线，必须以字母或数字开头，最长64个字符', 'description' => '属性标识，支持大小写字母、数字、下划线，必须以字母或数字开头，最长64个字符', 'type' => 'string', 'example' => 'apiCode'],
'DisplayName' => ['title' => '展示名称，最长32个字符', 'description' => '展示名称，最长32个字符', 'type' => 'string', 'example' => 'API编码'],
'Type' => [
'title' => '属性类型，支持 STRING、TEXT、INT、FLOAT、BOOLEAN、DATE、ARRAY、ENUM、JSON',
'description' => '属性类型，支持 STRING、TEXT、INT、FLOAT、BOOLEAN、DATE、ARRAY、ENUM、JSON',
'type' => 'string',
'example' => 'STRING',
'enum' => ['STRING', 'TEXT', 'INT', 'FLOAT', 'BOOLEAN', 'DATE', 'ARRAY', 'ENUM', 'JSON'],
],
'IsOptional' => ['title' => '是否可选，默认为true', 'description' => '取值是否可选，默认为true'."\n"
.'在创建实体时会进行校验，如果该值为false，但创建时未提供，会校验失败报错', 'type' => 'boolean', 'example' => 'true'],
'SearchFilterEnabled' => ['title' => '是否支持作为筛选条件，默认为false；仅 STRING、DATE、ENUM、ARRAY、INT、BOOLEAN 支持开启', 'description' => '是否支持作为页面筛选条件（只影响搜索页面），默认为false；'."\n"
."\n"
.'仅 STRING、DATE、ENUM、ARRAY、INT、BOOLEAN 类型支持开启', 'type' => 'boolean', 'example' => 'false'],
'DisplayEnabled' => ['title' => '是否在页面展示，默认为true', 'description' => '是否在详情页展示，默认为true', 'type' => 'boolean', 'example' => 'true'],
'AllowedValues' => [
'title' => '枚举可选值，type=ENUM时必填',
'description' => '枚举可选值，type=ENUM时必填',
'type' => 'array',
'items' => ['description' => '可选值', 'type' => 'string', 'example' => 'LABEL_1'],
],
'Description' => ['title' => '属性描述', 'description' => '属性描述', 'type' => 'string', 'example' => '层级描述'],
],
],
'MetaEntityDef' => [
'title' => '自定义实体定义',
'description' => '自定义实体定义',
'type' => 'object',
'properties' => [
'Name' => ['title' => '类型定义名称；纯自定义类型示例 customer_api，扩展表类型示例 customer-table', 'description' => '类型定义名称；', 'type' => 'string', 'example' => 'biz_api'],
'EntityType' => ['title' => '实体类型；纯自定义为 custom_entity-{name}，扩展类型为 custom_{name}', 'description' => '实体类型；', 'type' => 'string', 'example' => 'custom_entity-biz_api'],
'DisplayName' => ['title' => '展示名称', 'description' => '展示名称', 'type' => 'string', 'example' => '业务API'],
'Description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'test'],
'AttributeDefs' => [
'title' => '属性定义列表',
'description' => '实体属性定义对象列表',
'type' => 'array',
'items' => ['description' => '实体属性定义对象', '$ref' => '#/components/schemas/MetaEntityAttributeDef'],
],
'Extend' => [
'title' => '扩展模式，NONE表示纯自定义，TABLE表示扩展表类型',
'description' => '扩展模式，NONE表示纯自定义，TABLE表示扩展表类型',
'type' => 'string',
'example' => 'NONE',
'enum' => ['NONE', 'TABLE'],
],
'CreateTime' => ['title' => '创建时间，毫秒级时间戳', 'description' => '创建时间，毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1780553640613'],
'ModifyTime' => ['title' => '更新时间，毫秒级时间戳', 'description' => '更新时间，毫秒级时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1780553640613'],
],
],
'MetaEntityWriteResult' => [
'title' => '实体写入结果',
'description' => '实体写入结果',
'type' => 'object',
'properties' => [
'Name' => ['title' => '实体名称', 'description' => '实体名称', 'type' => 'string', 'example' => 'entity_01'],
'EntityType' => ['title' => '实体类型', 'description' => '实体类型', 'type' => 'string', 'example' => 'custom_entity-demo'],
'Id' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'example' => 'custom_entity-demo:entity_01'],
'Success' => ['title' => '该实体是否处理成功', 'description' => '该实体是否处理成功', 'type' => 'boolean', 'example' => 'true'],
'ErrorMessage' => ['title' => '该实体处理失败时的错误信息', 'description' => '该实体处理失败时的错误信息', 'type' => 'string', 'example' => 'The specified parameters are invalid.'],
],
],
'Partition' => [
'cloudType' => 'public',
'branchId' => 5136755,
'branchName' => 'master',
'paramExtraInfo' => [
'$.components.schemas.Partition.properties.Name.example' => 'ds=20250101', '$.components.schemas.Partition.properties.ModifyTime.description' => '修改时间（毫秒级时间戳）', '$.components.schemas.Partition.description' => '数据表的分区对象', '$.components.schemas.Partition.properties.TableId.description' => '所属数据表ID，可参考`Table`对象。', '$.components.schemas.Partition.properties.TableId.example' => 'maxcompute-table:::project_name:[schema_name]:table_name', '$.components.schemas.Partition.properties.CreateTime.example' => '1700192563000', '$.components.schemas.Partition.properties.RecordCount.description' => '分区记录数', '$.components.schemas.Partition.properties.RecordCount.example' => '1000000', '$.components.schemas.Partition.properties.DataSize.description' => '分区存储量，单位：字节', '$.components.schemas.Partition.properties.DataSize.example' => '4096',
'$.components.schemas.Partition.properties.Name.description' => '名称', '$.components.schemas.Partition.properties.ModifyTime.example' => '1700192563000', '$.components.schemas.Partition.properties.CreateTime.description' => '创建时间（毫秒级时间戳）',
],
'title' => '数据表的分区对象',
'description' => '数据表的分区对象',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'TableId' => ['title' => '所属数据表的资源标识', 'description' => '所属数据表ID，可参考[元数据实体相关概念说明](~~2880092~~)。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-table:accountId::project::table', 'backendName' => 'tableId', 'bizType' => 'normal'],
'Name' => ['title' => '名称', 'description' => '名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=20250101', 'backendName' => 'name', 'bizType' => 'normal'],
'CreateTime' => ['title' => '创建时间（毫秒级时间戳）', 'description' => '创建时间（毫秒级时间戳）', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1700192563000', 'backendName' => 'createTime'],
'ModifyTime' => ['title' => '修改时间（毫秒级时间戳）', 'description' => '修改时间（毫秒级时间戳）', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1700192563000', 'backendName' => 'modifyTime'],
'RecordCount' => ['title' => '分区记录数', 'description' => '分区记录数', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000', 'backendName' => 'recordCount'],
'DataSize' => ['title' => '分区存储量，单位：字节', 'description' => '分区存储量，单位：字节', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'backendName' => 'dataSize'],
],
],
'Schema' => [
'cloudType' => 'public',
'branchId' => 5125178,
'branchName' => 'master',
'paramExtraInfo' => [
'$.components.schemas.Schema.properties.ModifyTime.description' => '更新时间（毫秒级时间戳），目前仅MaxCompute类型支持该字段。', '$.components.schemas.Schema.properties.Name.example' => 'schema_name', '$.components.schemas.Schema.properties.CreateTime.example' => '1736852168000', '$.components.schemas.Schema.properties.Name.description' => '名称。', '$.components.schemas.Schema.description' => '模式。', '$.components.schemas.Schema.properties.CreateTime.description' => '创建时间（毫秒级时间戳），目前仅MaxCompute类型支持该字段。', '$.components.schemas.Schema.properties.Type.description' => '类型。', '$.components.schemas.Schema.properties.ModifyTime.example' => '1736852168000', '$.components.schemas.Schema.properties.Id.example' => 'maxcompute-schema:::project_name:schema_name', '$.components.schemas.Schema.properties.ParentMetaEntityId.example' => 'maxcompute-project:::project_name',
'$.components.schemas.Schema.properties.Comment.description' => '注释。', '$.components.schemas.Schema.properties.Comment.example' => 'test comment', '$.components.schemas.Schema.properties.Id.description' => '模式ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级使用空字符占位'."\n"
."\n"
.'> 对于maxcompute类型，实例ID层级使用空字符占位，数据库名称为maxcompute项目名称，且要求该项目已开启三层模型。'."\n"
."\n"
.'几种常用类型的ID格式参考如下'."\n"
."\n"
.'`maxcompute-schema:::project_name:schema_name` （要求该项目已开启三层模型）'."\n"
."\n"
.'`holo-schema:instance_id::database_name:schema_name`'."\n"
."\n"
.'> 其中 '."\n"
.'`instance_id`: holo实例ID '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`project_name`: maxcompute项目名 '."\n"
.'`schema_name`: schema名称', '$.components.schemas.Schema.properties.Type.example' => 'MANAGED', '$.components.schemas.Schema.properties.ParentMetaEntityId.description' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级使用空字符占位。'."\n"
."\n"
.'> 对于maxcompute类型，实例id层级使用空字符占位，数据库名称为maxcompute项目名称，要求该项目已开启三层模型。'."\n"
."\n"
.'几种常用类型的ParentMetaEntityId格式参考如下'."\n"
."\n"
.'`maxcompute-project:::project_name` （要求该项目已开启三层模型）'."\n"
."\n"
.'`holo-database:instance_id::database_name`'."\n"
."\n"
.'> 其中 '."\n"
.'`instance_id`: holo实例ID '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`project_name`: maxcompute项目名',
],
'title' => '模式',
'description' => '模式。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => 'ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录名称}:${数据库名称}:${模式名称}`，对于不存在的层级置空。'."\n"
."\n"
.'> 对于MaxCompute类型，此处的实例ID即为主账号ID，数据库名称即为MaxCompute项目名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-schema:123456XXX::test_project:default'."\n"
.'holo-schema:h-abc123xxx::test_db:test_schema', 'backendName' => 'id'],
'Name' => ['title' => '名称', 'description' => '名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_db', 'backendName' => 'name'],
'Comment' => ['title' => '注释', 'description' => '注释。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test comment', 'backendName' => 'comment'],
'Type' => ['title' => '类型', 'description' => '类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'MANAGED', 'backendName' => 'type'],
'ParentMetaEntityId' => ['title' => '父层级元数据实体ID', 'description' => '父层级元数据实体ID，父层级实体类型取值参考ListCrawlerTypes接口。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录名称}:${数据库名称}`，对于不存在的层级置空。'."\n"
."\n"
.'> 对于MaxCompute类型，此处的实例ID即为主账号ID，数据库名称即为MaxCompute项目名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-project:123456XXX::test_project'."\n"
.'holo-database:h-abc123xxx::test_db', 'backendName' => 'parentMetaEntityId'],
'CreateTime' => ['title' => '创建时间（毫秒级时间戳）', 'description' => '创建时间（毫秒级时间戳）。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'createTime'],
'ModifyTime' => ['title' => '更新时间（毫秒级时间戳）', 'description' => '更新时间（毫秒级时间戳）。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'modifyTime'],
],
],
'Table' => [
'title' => '数据表对象',
'description' => '数据表对象。',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => 'ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}`，对于不存在的层级使用空字符占位'."\n"
."\n"
.'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n"
."\n"
.'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。 '."\n"
."\n"
.'几种常用类型的ID格式如下 '."\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"
.'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`catalog_id`: dlf目录ID '."\n"
.'`project_name`: maxcompute项目名称 '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供。若未开启则使用空字符占位 '."\n"
.'`table_name`: 表名称', 'type' => 'string', 'example' => 'dlf-table::catalog_id:database_name::table_name'],
'Name' => ['title' => '名称', 'description' => '名称。', 'type' => 'string', 'example' => 'table_name'],
'Comment' => ['title' => '注释', 'description' => '注释。', 'type' => 'string', 'example' => '测试表'],
'TableType' => ['title' => '表类型', 'description' => '表类型，取值与元数据采集器类型相关。', 'type' => 'string', 'example' => 'TABLE'],
'PartitionKeys' => [
'title' => '分区键',
'description' => '分区键列表，非分区表时为空。',
'type' => 'array',
'items' => ['description' => '分区键。', 'type' => 'string', 'example' => 'ds'],
],
'ParentMetaEntityId' => ['title' => '父层级元数据实体ID', 'description' => '父层级元数据实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'- 对于支持schema的类型（`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle， 其中maxcompute类型需要所属项目开启三层模型)`, `ParentMetaEntityId`为表所属数据库模式，格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级空字符占位'."\n"
."\n"
.'- 其他类型时，`ParentMetaEntityId`为表所属数据库，格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级空字符占位。'."\n"
."\n"
.'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称。'."\n"
."\n"
.'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n"
."\n"
.'几种常用类型的ParentMetaEntityId格式参考如下'."\n"
.' '."\n"
.'`maxcompute-project:::project_name`'."\n"
."\n"
.'`maxcompute-schema:::project_name:schema_name` (仅项目开启三层模型时)'."\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`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`catalog_id`: dlf目录ID '."\n"
.'`project_name`: maxcompute项目名称 '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`schema_name`: schema名称', 'type' => 'string', 'example' => 'dlf-database::catalog_id:database_name'],
'CreateTime' => ['title' => '创建时间（毫秒级时间戳）', 'description' => '创建时间（毫秒级时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000'],
'ModifyTime' => ['title' => '修改时间（毫秒级时间戳）', 'description' => '修改时间（毫秒级时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000'],
'TechnicalMetadata' => [
'title' => '技术元数据',
'description' => '技术元数据。',
'type' => 'object',
'properties' => [
'Owner' => ['title' => '负责人', 'description' => '负责人。', 'type' => 'string', 'example' => 'test_user'],
'Location' => ['title' => '存储位置', 'description' => '存储位置。', 'type' => 'string', 'example' => 'oss://test-bucket/test_tbl'],
'Compressed' => ['title' => '是否为压缩表', 'description' => '是否为压缩表。', 'type' => 'boolean', 'example' => 'false'],
'InputFormat' => ['title' => '输入格式', 'description' => '输入格式。', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat'],
'OutputFormat' => ['title' => '输出格式', 'description' => '输出格式。', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat'],
'SerializationLibrary' => ['title' => 'SerDe使用的类', 'description' => 'SerDe使用的类。', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe'],
'Parameters' => [
'title' => '参数信息',
'description' => '参数信息。',
'type' => 'object',
'additionalProperties' => ['description' => '参数信息。', 'type' => 'string', 'example' => 'value'],
],
],
],
'BusinessMetadata' => [
'title' => '业务元数据',
'description' => '业务元数据，DataWorks相关，包含使用说明，标签，类目，上游产出任务以及扩展信息。',
'type' => 'object',
'properties' => [
'Readme' => ['title' => '使用说明', 'description' => '使用说明。', 'type' => 'string', 'example' => '## 使用说明'],
'CustomAttributes' => [
'title' => '自定义属性值，key为自定义属性标识，value为属性值列表',
'description' => '自定义属性值，key为自定义属性标识，value为属性值列表',
'type' => 'object',
'additionalProperties' => [
'title' => '自定义属性值的数组，当前仅支持单值数组',
'description' => '属性值列表',
'type' => 'array',
'items' => ['title' => '自定义属性值', 'description' => '属性值', 'type' => 'string', 'example' => '张三'],
],
],
'Tags' => [
'title' => '标签列表',
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签信息。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键，非空', 'description' => '标签键，非空。', 'type' => 'string', 'example' => 'tag_key'],
'Value' => ['title' => '标签值，可为空', 'description' => '标签值，可为空。', 'type' => 'string', 'example' => 'tag_value'],
],
],
],
'Categories' => [
'title' => '所属类目列表',
'description' => '所属类目列表。',
'type' => 'array',
'items' => [
'description' => '单一类目的层级列表（多级类目）。',
'type' => 'array',
'items' => [
'description' => '类目信息。',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'ID', 'description' => '类目ID。', 'type' => 'string', 'example' => 'CATEGORY.456'],
'Name' => ['title' => '名称', 'description' => '名称。', 'type' => 'string', 'example' => '测试类目'],
'ParentId' => ['title' => '父类目ID', 'description' => '父类目ID，可为空。', 'type' => 'string', 'example' => 'CATEGORY.123'],
],
],
],
],
'UpstreamTasks' => [
'title' => '上游产出任务列表',
'description' => '上游产出任务列表。',
'type' => 'array',
'items' => [
'description' => '上游产出任务。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '任务ID', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'Name' => ['title' => '任务名称', 'description' => '任务名称。', 'type' => 'string', 'example' => 'test_task'],
],
],
],
'Extension' => [
'title' => '扩展信息，目前仅MaxCompute类型支持',
'description' => '扩展信息，目前仅MaxCompute类型支持。',
'type' => 'object',
'properties' => [
'ProjectId' => ['title' => '工作空间ID', 'description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '234'],
'EnvType' => [
'title' => '环境类型',
'description' => '环境类型，枚举值，取值范围'."\n"
."\n"
.'- Prod：生产环境。'."\n"
.'- Dev：开发环境。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Dev',
'enum' => ['Dev', 'Prod'],
],
'ViewCount' => ['title' => '浏览次数', 'description' => '浏览次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ReadCount' => ['title' => '读取次数', 'description' => '读取次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FavorCount' => ['title' => '收藏次数', 'description' => '收藏次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
],
],
],
'StatisticsInfos' => [
'type' => 'object',
'additionalProperties' => ['type' => 'string'],
],
],
],
],
],
'apis' => [
'AbolishPipelineRun' => [
'summary' => '调用该接口，会将指定发布流程的状态变更为终止状态，但不会删除这个发布流程，仍然可以通过查询接口查询到。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '267906',
'abilityTreeNodes' => ['FEATUREdide4AR6E0'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '发布流程的唯一标识', 'type' => 'string', 'required' => true, 'example' => '1606087c-9ac4-43f0-83a8-0b5ced21XXXX'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '55D786C9-DD57-524D-884C-C5239278XXXX'."\n"],
'Success' => ['description' => '请求是否成功。取值如下：'."\n"
.'- true：成功。'."\n"
.'- false：失败。', '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' => '终止发布流程',
'description' => '>低版本的SDK中可能无该接口，此时请使用AbolishDeployment接口，参数与该文档一致。>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'AddEntityIntoMetaCollection' => [
'summary' => '向数据地图集合中添加给定实体对象，集合对象支持数据地图类目和数据专辑两种，实体对象当前仅支持数据表类型。'."\n"
.'向数据专辑添加实体时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。',
'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' => '集合对象Id，可参考ListMetaCollections接口返回结果。', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'description' => '实体Id，目前仅支持表类型，可参考ListTables接口返回结果。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'maxcompute-table:::project_name:[schema_name]:table_name',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => '添加到集合时的备注信息，'."\n"
.'目前仅对专辑类型生效。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\"\\n}","type":"json"}]',
'title' => '向数据地图集合中添加实体对象',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ApplyResourceAccessPermission' => [
'summary' => '用于提交对特定资源的访问权限申请。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Reason',
'in' => 'formData',
'schema' => ['description' => '申请理由'."\n", 'type' => 'string', 'required' => true, 'example' => '业务发展需要'],
],
[
'name' => 'ApplyContents',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '资源权限申请内容列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Resource' => [
'description' => '资源描述。',
'type' => 'object',
'properties' => [
'DefSchema' => [
'description' => '资源类型。'."\n"
."\n"
.'**注意**：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'],
'example' => 'MaxCompute',
],
'DefVersion' => ['description' => '资源解析版本受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version约束。'."\n"
."\n"
.'[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'v1.0.0', 'default' => 'v1.0.0'],
'MetaData' => [
'description' => '资源元数据声明。'."\n"
."\n"
.'**注意**：元数据受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources 约束，有效的资源声明需要包含level 0到validLeaf层的全路径元数据声明。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'any', 'description' => '通过Map格式声明具体资源，需要符合ResourceSchema中具体资源类型的resource约束。'."\n"
."\n\n"
.'注意：'."\n"
.'1. MaxCompute申请列权限时同步声明列安全等级columnSensibleLevel才会进行label授权。'."\n"
.'2. 开启Schema的MaxCompute权限申请需传递threeTierModel参数并设置为true。', 'example' => '{'."\n"
.' "workspace": "449656",'."\n"
.' "project": "sync_destination",'."\n"
.' "table": "order_table",'."\n"
.' "threeTierModel": false'."\n"
.' }'],
],
],
'required' => false,
],
'Grantee' => [
'description' => '授权主体描述。'."\n"
."\n"
.'**注意**： 系统支持的授权主体类型受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'PrincipalType' => [
'description' => '授权主体类型。枚举：'."\n"
."\n"
.'- RamRole'."\n"
.'- RamUser'."\n"
.'- DlfRole',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['DlfRole' => 'DlfRole', 'RamUser' => 'RamUser', 'RamRole' => 'RamRole'],
'example' => 'RamRole',
],
'PrincipalId' => ['description' => '授权主体 ID，不同主授权主体类型映射 ID 具有不同语义：'."\n"
."\n"
.'- RamUser：Dataworks UserId'."\n"
.'- RamRole "ROLE_"开头的 Dataworks UserId'."\n"
."\n"
.'- DlfRole: DlfNext 角色名称', 'type' => 'string', 'required' => true, 'example' => 'ROLE_32237475848545'],
],
'required' => true,
],
'AccessTypes' => [
'description' => '申请的权限列表。'."\n"
."\n"
.'**注意**：不同层级资源支持权限的申请类型不同，统一受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf和accessTypeRestrictions和authMethodAccessTypes 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'array',
'items' => ['description' => '资源权限', 'type' => 'string', 'required' => false, 'example' => 'select'],
'required' => true,
],
'ExpirationTime' => ['description' => '权限到期时间，毫秒时间戳'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1785835708000'],
'AuthMethod' => [
'description' => '授权方式。当前只有SEVERLESS_STARROCKS支持指定授权方式：ranger、starrocksManager。'."\n"
."\n"
.'**注意**：不同资源支持的授权方式不同，统一受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authMethods 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['starrocksManager' => 'Starrocks Manager', 'ranger' => 'Ranger'],
'example' => 'ranger',
],
],
'required' => false,
'description' => '',
],
'required' => true,
'maxItems' => 400,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等参数。用于避免多次调用导致操作重复。', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
'Data' => [
'description' => '申请单ID列表。',
'type' => 'array',
'items' => ['description' => '申请单/审批流程 ID', 'type' => 'string', 'example' => '332066440109224007'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '发起资源访问权限申请',
'description' => '## 请求说明'."\n"
.'- **Reason**：申请理由，必须提供。'."\n"
.'- **ApplyContents**：包含多个资源权限申请内容，每个内容包括资源描述（Resource）、授权主体描述（Grantee）、权限类型（AccessTypes）和权限到期时间（ExpirationTime）。单次最大限制400条。'."\n"
.'- **Resource**：资源描述，需要指定资源解析依赖的ResourceSchema.name和version，以及资源元数据MetaData。'."\n"
.'- **Grantee**：授权主体描述，需要指定授权主体类型（PrincipalType）和主体ID（PrincipalId）。'."\n"
.'- **AccessTypes**：权限类型列表，支持多种权限组合。'."\n"
.'- **ExpirationTime**：权限到期时间，以毫秒时间戳形式提供。'."\n"
.'- **AuthMethod**：可选参数，指定授权方式，默认使用系统内置的默认授权方式。'."\n"
.'- **ClientToken**：客户端令牌，用于防止重复请求，非必填项。'."\n"
."\n"
.'请确保所有必填字段都已正确填写，并且符合相应的约束条件。例如，`Resource`中的`DefVersion`和`MetaData`应与所选`DefSchema`相匹配。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"Data\\": [\\n \\"332066440109224007\\"\\n ]\\n}","type":"json"}]',
],
'ApproveProcessInstance' => [
'summary' => '用于对指定的审批流程实例进行同意或拒绝操作。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '243667',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProcessInstanceId',
'in' => 'formData',
'schema' => ['description' => '流程实例ID，支持新、老安全中心的审批单'."\n", 'type' => 'string', 'required' => true, 'example' => '332066440109224007'],
],
[
'name' => 'ApprovalComment',
'in' => 'formData',
'schema' => ['description' => '审批意见'."\n", 'type' => 'string', 'required' => true, 'example' => '同意授权'],
],
[
'name' => 'NewExpiration',
'in' => 'formData',
'schema' => ['description' => '修改授权到期时间。 毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1782541464000'],
],
[
'name' => 'ApprovalAction',
'in' => 'formData',
'schema' => [
'description' => '审批行为：'."\n"
."\n"
.'- Agree（同意）'."\n"
."\n"
.'- Deny（拒绝）',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['Agree' => 'Agree', 'Deny' => 'Deny'],
'example' => 'Agree',
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等串，建议使用UUID。', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9*****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '审批工作流实例',
'description' => '## 请求说明'."\n"
.'- 该接口允许用户通过传入 `ProcessInstanceId` 和审批信息（包括 `ApprovalComment` 和 `ApprovalAction`）来对指定的审批流程实例进行审批操作。'."\n"
.'- `ApprovalAction` 可以是 `Agree` 或 `Deny`，分别表示同意或拒绝审批。'."\n"
.'- 审批意见 `ApprovalComment` 是必填项，用于记录审批的具体意见。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]',
],
'AssociateProjectToImage' => [
'summary' => '关联镜像到工作空间。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245182',
'abilityTreeNodes' => ['FEATUREdide2SV6DS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'Data' => ['title' => 'API请求结果', 'description' => 'API请求结果', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '关联镜像到工作空间',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'AssociateProjectToResourceGroup' => [
'summary' => '绑定资源组到某个工作空间。',
'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' => '资源组唯一标识', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['title' => '要绑定的工作空间ID', 'description' => '要绑定的工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', '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' => '绑定资源组到某个工作空间',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:AssociateProjectToResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'AttachDataQualityRulesToEvaluationTask' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '250888',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100001'],
],
[
'name' => 'DataQualityEvaluationTaskId',
'in' => 'formData',
'schema' => ['description' => '关联的质量校验任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '200001'],
],
[
'name' => 'DataQualityRuleIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量规则ID列表。',
'type' => 'array',
'items' => ['description' => '数据质量规则ID列表。', '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' => '关联是否成功，取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'],
],
'title' => '关联数据质量规则与数据质量监控',
'summary' => '把数据质量规则关联到数据质量校验任务上。',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'BatchCreateMetaEntities' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Entities',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '实体列表，最多5个；同一批次必须为同一种entityType',
'description' => '实体列表，最多5个；同一批次必须为同一种entityType',
'type' => 'array',
'items' => [
'description' => '实体对象',
'type' => 'object',
'properties' => [
'EntityType' => ['title' => '实体类型，需匹配 `^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$`', 'description' => '实体类型, 统一批次须一致，支持'."\n"
.'- 纯自定义类型，如custom_entity-biz_api'."\n"
.'- 扩展表类型，如果注册了元数据实体类型 custom_dw-table，支持创建对应的数据库类型 custom_dw-database 和 数据表 类型 custom_dw-table的对象', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api'],
'Name' => ['title' => '实体名称，由大小写字母、数字、下划线组成，必须以字母开头，最长64字符', 'description' => '实体名称，由大小写字母、数字、下划线组成，必须以字母开头，最长64字符', 'type' => 'string', 'required' => true, 'example' => 'api_001'],
'Comment' => ['title' => '注释', 'description' => '注释', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
'Attributes' => [
'title' => '实体属性，复杂值需要序列化为JSON字符串',
'description' => '实体属性，复杂值需要序列化为JSON字符串',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'string', 'example' => 'key1', 'description' => '实体属性'],
],
'CustomAttributes' => [
'title' => '自定义属性值，key为自定义属性标识，value最多一个值',
'description' => '自定义属性值，key为自定义属性标识，value当前仅支持单值。'."\n"
.'这里用到的自定义属性，需要通过CreateCustomAttribute API预先创建，比如通过API创建ID为 `custom-attribute:owner_name`的自定义属性后，这里可以配置 {\'owner_name\': [\'Bob\']}完成自定义属性配置',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'value1', 'description' => '自定义属性值'],
'description' => '自定义属性值列表',
],
],
],
'required' => false,
],
'required' => true,
'example' => '[]',
'maxItems' => 5,
'minItems' => 1,
],
],
],
'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' => '9E0C8E7A-C6BE-5A73-9562-2A030A80E8C6'],
'Success' => ['title' => '请求是否成功；部分实体失败时仍返回true，逐条结果见Results[].Success和Results[].ErrorMessage', 'description' => '请求是否成功；部分实体失败时仍返回true，逐条结果见Results[].Success和Results[].ErrorMessage', 'type' => 'boolean', 'example' => 'true'],
'Results' => [
'title' => '实体写入结果列表；逐条返回创建是否成功及失败原因',
'description' => '实体写入结果列表；逐条返回创建是否成功及失败原因',
'type' => 'array',
'items' => ['description' => '批量创建结果。', '$ref' => '#/components/schemas/MetaEntityWriteResult'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '批量创建元数据实体',
'summary' => '批量创建元数据实体，同一批次需要为同一种类型，当前仅支持纯自定义类型和扩展表类型（对应Database/Table）。',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'requestParamsDescription' => '## 扩展 Database'."\n"
."\n"
.'`EntityType` 使用 `custom_xxx-database`。其中 `xxx` 来自已创建的 `custom_xxx-table` 扩展 EntityDef。'."\n"
."\n"
.'### Attributes'."\n"
."\n"
.'| Attributes key | 是否必填 | 类型/写法 | 说明 |'."\n"
.'|----------------|----------|-----------|------|'."\n"
.'| `parentMetaEntityId` | 是 | String | 父实例 ID，必须是 instance 层，不能包含 catalog/database/schema/table/column |'."\n"
.'| `technicalMetadata.location` | 否 | String | Database 存储位置 |'."\n"
."\n"
.'## 扩展 Table'."\n"
."\n"
.'`EntityType` 使用 `custom_xxx-table`。Table 的字段也需要在这里通过 `Attributes.columns` 一起注册。'."\n"
."\n"
.'### Attributes'."\n"
."\n"
.'| Attributes key | 是否必填 | 类型/写法 | 说明 |'."\n"
.'|----------------|----------|-----------|------|'."\n"
.'| `parentMetaEntityId` | 是 | String | 父 Database ID，必须是 database 层 |'."\n"
.'| `tableType` | 否 | String | 表类型；不传默认 `TABLE` |'."\n"
.'| `partitionKeys` | 否 | JSON Array 字符串 | 分区键，例如 `["dt"]` |'."\n"
.'| `technicalMetadata.location` | 否 | String | 存储位置 |'."\n"
.'| `technicalMetadata.compressed` | 否 | Boolean 字符串或 JSON boolean | 是否压缩 |'."\n"
.'| `technicalMetadata.inputFormat` | 否 | String | InputFormat |'."\n"
.'| `technicalMetadata.outputFormat` | 否 | String | OutputFormat |'."\n"
.'| `technicalMetadata.serializationLibrary` | 否 | String | SerDe 类 |'."\n"
.'| `technicalMetadata.parameters` | 否 | JSON Object 字符串 | 参数信息，例如 `{"retention":"30"}` |'."\n"
.'| `columns` | 否 | JSON Array 字符串 | 内嵌字段列表；用于随 Table 一起注册扩展 Column |'."\n"
."\n"
.'### Attributes.columns'."\n"
."\n"
.'`columns` 是 `Attributes` 里的一个 JSON Array 字符串。数组内每个对象支持以下字段：'."\n"
."\n"
.'| columns item key | 是否必填 | 类型/写法 | 说明 |'."\n"
.'|------------------|----------|-----------|------|'."\n"
.'| `name` | 是 | String | 字段名；为空会跳过该字段 |'."\n"
.'| `type` | 是 | String | 字段类型；缺失会报 `attributes.columns[i].type` |'."\n"
.'| `comment` | 否 | String | 字段注释 |'."\n"
.'| `position` | 否 | Integer | 字段位置；不传默认按数组顺序 `i + 1` |'."\n"
.'| `partitionKey` | 否 | Boolean | 是否分区键 |'."\n"
.'| `primaryKey` | 否 | Boolean | 是否主键 |'."\n"
.'| `customAttributes` | 否 | Object | 字段自定义属性值|'."\n"
."\n"
.'## 示例'."\n"
."\n"
.'### 创建扩展 Database'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Entities": ['."\n"
.' {'."\n"
.' "EntityType": "custom_demo-database",'."\n"
.' "Name": "ods",'."\n"
.' "Comment": "ODS database",'."\n"
.' "Attributes": {'."\n"
.' "parentMetaEntityId": "custom_demo:demo_source",'."\n"
.' "technicalMetadata.location": "oss://bucket/ods"'."\n"
.' },'."\n"
.' "CustomAttributes": {'."\n"
.' "biz_owner": ["data_team"]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 创建扩展 Table，同时注册字段'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Entities": ['."\n"
.' {'."\n"
.' "EntityType": "custom_demo-table",'."\n"
.' "Name": "order_fact",'."\n"
.' "Comment": "订单事实表",'."\n"
.' "Attributes": {'."\n"
.' "parentMetaEntityId": "custom_demo-database:demo_source::ods",'."\n"
.' "tableType": "TABLE",'."\n"
.' "partitionKeys": "[\\"dt\\"]",'."\n"
.' "technicalMetadata.location": "oss://bucket/ods/order_fact",'."\n"
.' "technicalMetadata.compressed": "true",'."\n"
.' "technicalMetadata.parameters": "{\\"retention\\":\\"30\\",\\"bizDomain\\":\\"trade\\"}",'."\n"
.' "columns": "[{\\"name\\":\\"id\\",\\"type\\":\\"BIGINT\\",\\"comment\\":\\"主键\\",\\"position\\":1,\\"primaryKey\\":true,\\"customAttributes\\":{\\"security_level\\":[\\"P1\\"]}},{\\"name\\":\\"dt\\",\\"type\\":\\"STRING\\",\\"comment\\":\\"分区日期\\",\\"position\\":2,\\"partitionKey\\":true}]"'."\n"
.' },'."\n"
.' "CustomAttributes": {'."\n"
.' "biz_owner": ["data_team"]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'## 注意事项'."\n"
."\n"
.'- 扩展 Database 的 `parentMetaEntityId` 必须是实例层，例如 `custom_demo:demo_source`。'."\n"
.'- 扩展 Table 的 `parentMetaEntityId` 必须是 Database 层，例如 `custom_demo-database:demo_source::ods`。'."\n"
.'- 父子实体必须属于同一个扩展族，例如 `custom_demo-table` 的父级必须是 `custom_demo-database`。'."\n"
.'- `columns` 只能随 Table 创建提供，不能通过 `BatchCreateMetaEntities` 单独创建 `custom_xxx-column`。'."\n"
.'- 扩展实体写入路径不会按 `MetaEntityDef.AttributeDefs` 严格拦截未知 `Attributes` key；未知 key 通常会被忽略。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9E0C8E7A-C6BE-5A73-9562-2A030A80E8C6\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"Name\\": \\"entity_01\\",\\n \\"EntityType\\": \\"custom_entity-demo\\",\\n \\"Id\\": \\"custom_entity-demo:entity_01\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\"\\n }\\n ]\\n}","type":"json"}]',
],
'BatchDeleteMetaEntities' => [
'summary' => '批量删除元数据实体对象，支持删除创建的纯自定义实体，扩展表类型对象(Database/Table)，不支持单独删除column，可以通过删除Table,删除关联Column对象。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'title' => '待删除实体ID列表，最多10个；同一批次必须为同一种entityType',
'description' => '待删除实体ID列表，最多10个；同一批次必须为同一种entityType',
'type' => 'array',
'items' => ['description' => '参数ID列表。', 'type' => 'string', 'required' => false, 'example' => 'custom_entity-demo:entity_01'],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
],
],
],
'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' => '1FC02D76-4A94-5D97-B52C-00A031B95359'],
'Success' => ['title' => '请求是否成功；部分实体失败时仍返回true，逐条结果见Results[].Success和Results[].ErrorMessage', 'description' => '请求是否成功；部分实体失败时仍返回true，逐条结果见Results[].Success和Results[].ErrorMessage', 'type' => 'boolean', 'example' => '[]'],
'Results' => [
'title' => '实体删除结果列表；逐条返回删除是否成功及失败原因',
'description' => '实体删除结果列表；逐条返回删除是否成功及失败原因',
'type' => 'array',
'items' => ['description' => '批量删除结果', '$ref' => '#/components/schemas/MetaEntityWriteResult'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '批量删除元数据实体',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FC02D76-4A94-5D97-B52C-00A031B95359\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"Name\\": \\"entity_01\\",\\n \\"EntityType\\": \\"custom_entity-demo\\",\\n \\"Id\\": \\"custom_entity-demo:entity_01\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\"\\n }\\n ]\\n}","type":"json"}]',
],
'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' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
'EnvType' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
'Name' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'required' => false, 'example' => '1000'],
'Timeout' => ['description' => '任务执行超时时间，单位秒。取值应大于3600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
'RerunMode' => [
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'AllAllowed',
'enum' => ['AllAllowed', 'FailureAllowed', 'AllDenied'],
],
'RerunTimes' => ['description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'RerunInterval' => ['description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
'Trigger' => [
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Scheduler',
'enum' => ['Scheduler', 'Manual'],
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'Skip', 'Pause'],
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'required' => false, 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '9999-01-01 00:00:00'],
],
'required' => false,
],
'RuntimeResource' => [
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'required' => false, 'example' => '0.25'],
],
'required' => false,
],
'DataSource' => [
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'required' => false, 'example' => 'odps_test'],
],
'required' => false,
],
'Tags' => [
'description' => '任务标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以任务ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => 'The task does not exist.', 'description' => '错误信息。'],
],
'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' => '批量更新任务',
'summary' => '以增量更新的方式，批量更新多个任务。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CancelAgentSession' => [
'summary' => '用于中断指定会话的Agent调用，支持流式响应中断。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '676303114031776'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '请求的业务参数',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '待取消的会话 ID，必填', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34'],
],
'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' => '7CD3D216-5876-5DB1-A34A-396806F4A413'],
'JsonRpcResponse' => [
'description' => 'JSON-RPC结果',
'type' => 'object',
'properties' => [
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'example' => '7675839888324361477'],
'Result' => [
'description' => '取消会话的结果对象',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => 'session-d5d549fe4c2c4180a9814fb74190f502'],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '取消会话',
'description' => '## 请求说明'."\n"
.'- 该接口主要用于用户主动中断正在进行中的会话，特别是当会话处于流式响应状态时。'."\n"
.'- `sessionId`是必需参数，用来标识要取消的具体会话。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CD3D216-5876-5DB1-A34A-396806F4A413\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"7675839888324361477\\",\\n \\"Result\\": {\\n \\"SessionId\\": \\"session-d5d549fe4c2c4180a9814fb74190f502\\"\\n }\\n }\\n}","type":"json"}]',
],
'CloneDataSource' => [
'summary' => '根据已有的数据源，克隆一条新的数据源。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '232442',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1603612'],
],
[
'name' => 'CloneDataSourceName',
'in' => 'query',
'schema' => ['description' => '目标数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长60个字符。', 'type' => 'string', 'required' => true, 'example' => 'demo_holo_datasource'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'FCD583B9-346B-5E75-82C1-4A7C192C48DB'],
'Id' => ['description' => '返回克隆创建的数据源ID，数据源的唯一标识符。', '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' => '克隆数据源',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [
['createdAt' => '2024-12-19T09:00:15.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:CloneDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateAgent' => [
'summary' => '创建 Agent',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'Agent 名称，在当前账号下唯一。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-agent'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => 'Agent 展示名称。'."\n", 'type' => 'string', 'required' => false, 'example' => '我的助手'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'Agent 描述。'."\n", 'type' => 'string', 'required' => false, 'example' => '数据分析助手'],
],
[
'name' => 'Model',
'in' => 'formData',
'style' => 'json',
'schema' => ['description' => '模型配置。'."\n", 'type' => 'object', 'required' => false, 'example' => '{'."\n"
.' "modelName": "dataworks-public-bailian/qwen-max"'."\n"
.' }'],
],
[
'name' => 'SystemPrompt',
'in' => 'formData',
'schema' => ['description' => '系统提示词。'."\n", 'type' => 'string', 'required' => false, 'example' => '你是一个数据分析助手。'],
],
[
'name' => 'Tools',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工具列表。'."\n",
'type' => 'array',
'items' => ['description' => '工具信息。', 'type' => 'string', 'required' => false, 'example' => '-'],
'required' => false,
'example' => '-',
],
],
[
'name' => 'Skills',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '技能列表。'."\n",
'type' => 'array',
'items' => ['description' => '技能配置', 'type' => 'string', 'required' => false, 'example' => '["my-skill"]'],
'required' => false,
'example' => '-',
],
],
[
'name' => 'CallableAgents',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '可被本 Agent 调用的子 Agent 列表。'."\n",
'type' => 'array',
'items' => ['description' => 'agent 名称', 'type' => 'string', 'required' => false, 'example' => '["agent-name"]'],
'required' => false,
'example' => '-',
],
],
[
'name' => 'Metadata',
'in' => 'formData',
'style' => 'json',
'schema' => ['description' => '扩展元数据（键值对）。'."\n", 'type' => 'object', 'required' => false, 'example' => '{}'],
],
[
'name' => 'Visibility',
'in' => 'formData',
'schema' => [
'description' => '可见性级别。
'."\n"
.'`TENANT`：账号内可见；
'."\n"
.'`PROJECT`：指定项目可见；
'."\n"
.'`USER`：指定用户可见。'."\n",
'type' => 'string',
'required' => false,
'example' => 'TENANT',
'enum' => ['TENANT', 'PROJECT', 'USER'],
],
],
[
'name' => 'VisibilityScope',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '可见性范围，按 Visibility 取对应字段。'."\n",
'type' => 'object',
'properties' => [
'ProjectIds' => [
'description' => '可见的项目 ID 列表，Visibility 为 `PROJECT` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '工作空间ID列表', 'type' => 'string', 'required' => false, 'example' => '[21791]'],
'required' => false,
],
'UserIds' => [
'description' => '可见的用户 ID 列表，Visibility 为 `USER` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '可见的用户 ID 列表，Visibility 为 USER 时生效。', 'type' => 'string', 'required' => false, 'example' => '[]'],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'Agent' => [
'description' => '创建的Agent详情',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'Agent 名称。'."\n", 'type' => 'string', 'example' => 'my-agent'],
'GmtCreateTime' => ['description' => '创建时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'GmtModifiedTime' => ['description' => '最近修改时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建 Agent',
'description' => '## 请求说明'."\n"
.'- **Agent 名称**：必须在当前账号下唯一。'."\n"
.'- **模型配置**：可选参数，用于指定 Agent 使用的模型及其相关设置。'."\n"
.'- **可见性级别**：定义了谁可以访问该 Agent，支持账号内、项目或特定用户可见。'."\n"
.'- **可见性范围**：当选择 `PROJECT` 或 `USER` 作为可见性级别时，需要进一步指定具体的项目 ID 或用户 ID 列表。'."\n"
.'- **其他参数**：如展示名称、描述等为非必填项，可根据实际需求填写。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Agent\\": {\\n \\"Name\\": \\"my-agent\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]',
],
'CreateAgentSession' => [
'summary' => '创建一个新的Agent会话并返回会话ID。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '4758330557805415712'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
'Meta' => [
'description' => '扩展元信息，承载 agent 绑定、会话来源、标签等'."\n",
'type' => 'object',
'properties' => [
'Agent' => [
'description' => '该会话运行的Agent配置，取值范围是ListAgents接口返回的结果',
'type' => 'object',
'properties' => [
'AgentName' => ['description' => '会话绑定的 Agent 名称，必填', 'type' => 'string', 'required' => false, 'example' => 'chat_cli_chatbi'],
],
'required' => false,
],
'Config' => [
'description' => 'Session配置参数，比如基于Session来源、Session Tag的过滤参数配置',
'type' => 'object',
'properties' => [
'SessionSource' => ['description' => '会话来源标识，便于按来源检索。比如Agent可以在A页面使用，也可以在B页面进行使用，此时如果有需求需要在A页面只展示A页面创建出来的Session，就可以基于该参数进行过滤。长度不超过128位，支持英文字母+数字+中划线+下划线组合。', 'type' => 'string', 'required' => false, 'example' => 'openapi_sdk'],
'SessionTags' => [
'description' => '会话标签列表，后续可以基于会话标签进行搜索过滤。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SessionTagCode' => ['description' => '会话标签。可以基于会话标签进行过滤，比如调用OpenAPI的时候用的是固定的RAM子账号，但是调用系统中有自己的账号体系，此时需要基于账号ID过滤Session列表，该标签就可以传调用系统的账号ID。长度不超过128位，支持英文字母+数字+中划线+下划线组合。', 'type' => 'string', 'required' => false, 'example' => 'chatbi'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'required' => false,
],
'InitialConfigOptions' => [
'description' => 'Agent执行环境的高级参数设置',
'type' => 'object',
'properties' => [
'ExecutionLane' => ['description' => '执行模式：'."\n"
.'* chat：仅对话模式，适合简单的问数、答疑的场景，优点是快、token消耗低，缺点是无法处理复杂问题'."\n"
.'* cli：沙箱模式，适合复杂的数据分析、数据处理、代码编写等场景，优点是能够处理复杂问题，模型自主进行分析和问题处理等，缺点是相对于chat模式处理速度慢，token消耗较高', 'type' => 'string', 'required' => false, 'example' => 'chat，cli'],
'Mode' => ['description' => '脚本执行的授权模式（OpenApi目前仅支持yolo模式）：'."\n"
.'* yolo：自动授权，无需人为介入，模型可以自动处理', 'type' => 'string', 'required' => false, 'example' => 'yolo'],
'Skills' => ['description' => '加载的自定义skill名称，多个用英文逗号相隔', 'type' => 'string', 'required' => false, 'example' => 'skill-name-1,skill-name2,skill-name-3'],
'ResourceGroupId' => ['description' => '初始化使用的资源组id', 'type' => 'string', 'required' => false, 'example' => 'Serverless_res_group_123123123_564657857'],
],
'required' => false,
],
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数（result）'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8A9D5E6C-5817-5837-9715-6E3967EC6123'],
'JsonRpcResponse' => [
'description' => 'JSON-PRC的返回结果',
'type' => 'object',
'properties' => [
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0'."\n", 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显'."\n", 'type' => 'string', 'example' => '1'],
'Result' => [
'description' => '业务数据；出错时为 null'."\n",
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '新建的会话 ID'."\n", 'type' => 'string', 'example' => 'sess_0f12abc34'],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建新会话',
'description' => '## 请求说明'."\n"
.'- 该接口用于创建一个新的Agent会话。'."\n"
.'- 通过`_meta.agent.agentName`指定绑定的Agent名称，这是必填项。'."\n"
.'- 可以通过`_meta.config.sessionSource`透传会话来源标识，便于后续按来源检索。'."\n"
.'- 支持通过`_meta.config.sessionTags[].sessionTagCode`传入会话标签。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateAgentSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8A9D5E6C-5817-5837-9715-6E3967EC6123\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"1\\",\\n \\"Result\\": {\\n \\"SessionId\\": \\"sess_0f12abc34\\"\\n }\\n }\\n}","type":"json"}]',
],
'CreateAlertRule' => [
'summary' => '创建自定义监控告警规则。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '249177',
'abilityTreeNodes' => ['FEATUREdideRJGWWC'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义规则名。', 'type' => 'string', 'required' => true, 'example' => 'xm_create_test'],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => '自定义规则的责任人阿里云UID。', 'type' => 'string', 'required' => true, 'example' => '279114181****'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '告警规则是否启用。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
'name' => 'TriggerCondition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '触发告警的条件。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '触发报警的类型，枚举值：'."\n"
.'- Finished: 实例完成'."\n"
.'- UnFinished: 实例未完成'."\n"
.'- Error: 实例出错'."\n"
.'- CycleUnfinished: 实例周期未完成'."\n"
.'- Timeout: 实例超时'."\n"
.'- InstanceTransferComplete: 任务转实例完成'."\n"
.'- InstanceTransferFluctuate: 实例数量波动'."\n"
.'- ExhaustedError: 自动重跑后仍出错'."\n"
.'- InstanceKeyword: 出错实例包含关键词'."\n"
.'- InstanceErrorCount: 出错实例数量'."\n"
.'- InstanceErrorPercentage: 出错实例占比'."\n"
.'- ResourceGroupPercentage: 资源组利用率'."\n"
.'- ResourceGroupWaitCount: 资源组等资源实例数', 'type' => 'string', 'required' => false, 'example' => 'Error'],
'Extension' => [
'description' => '扩展信息，部分触发条件需要配置。',
'type' => 'object',
'properties' => [
'Error' => [
'description' => '出错告警配置。',
'type' => 'object',
'properties' => [
'StreamTaskIds' => [
'description' => '监控实时计算任务时，填入对应的任务ID。',
'type' => 'array',
'items' => ['description' => '实时计算任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
],
'AutoRerunAlertEnabled' => ['description' => '离线任务由于失败自动重跑，是否产生告警。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
'Timeout' => [
'description' => '超时告警配置。',
'type' => 'object',
'properties' => [
'TimeoutInMinutes' => ['description' => '超时时间，单位为分钟，取值范围[1, 21600]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
'UnFinished' => [
'description' => '未完成告警配置。',
'type' => 'object',
'properties' => [
'UnFinishedTime' => ['description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'required' => false, 'example' => '30:00'],
],
'required' => false,
],
'CycleUnfinished' => [
'description' => '周期未完成告警配置。',
'type' => 'object',
'properties' => [
'CycleAndTime' => [
'description' => '周期和时间配置列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CycleId' => ['description' => '周期ID，取值范围为[1,288]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'Time' => ['description' => '超时时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'required' => false, 'example' => '12:00'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'InstanceErrorCount' => [
'description' => '实例出错数量告警配置。',
'type' => 'object',
'properties' => [
'Count' => ['description' => '出错的实例数，取值范围为[1,10000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
'required' => false,
],
'InstanceErrorPercentage' => [
'description' => '实例出错比例告警配置。',
'type' => 'object',
'properties' => [
'Percentage' => ['description' => '出错实例百分比，取值范围 [1-100]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
'required' => false,
],
'InstanceTransferFluctuate' => [
'description' => '转实例数量波动告警配置。',
'type' => 'object',
'properties' => [
'Trend' => ['description' => '转实例波动类型，枚举值：'."\n"
.'- abs: 绝对值'."\n"
.'- increase: 增长'."\n"
.'- decrease: 下降', 'type' => 'string', 'required' => false, 'example' => 'abs'],
'Percentage' => ['description' => '转实例波动百分比，取值范围[1-100]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
],
'required' => false,
],
'Target' => [
'description' => '监控对象。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型，枚举值：'."\n"
.'- Task: 任务节点'."\n"
.'- Baseline: 基线'."\n"
.'- Project: 工作空间'."\n"
.'- BizProcess - 业务流程', 'type' => 'string', 'required' => false, 'example' => 'Task'],
'Ids' => [
'description' => '监控对象ID列表。',
'type' => 'array',
'items' => ['description' => '监控对象ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123123'],
'required' => false,
],
'AllowTasks' => [
'description' => '监控任务白名单列表。',
'type' => 'array',
'items' => ['description' => '监控任务白名单ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
],
],
'required' => false,
],
],
'required' => true,
],
],
[
'name' => 'Notification',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警通知配置。',
'type' => 'object',
'properties' => [
'SilenceStartTime' => ['description' => '静默告警开始时间，格式为 HH:mm。', 'type' => 'string', 'required' => false, 'example' => '00:00'."\n"],
'SilenceEndTime' => ['description' => '静默告警结束时间，格式为 HH:mm', 'type' => 'string', 'required' => false, 'example' => '00:00'."\n"],
'IntervalInMinutes' => ['description' => '告警间隔，单位为分钟，取值范围[5,10000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
'Maximum' => ['description' => '一个自然日内的告警最大次数，取值范围[1, 10000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'Channels' => [
'description' => '告警通道列表。',
'type' => 'array',
'items' => ['description' => '告警通道，枚举值：'."\n"
.'- Mail: 邮件'."\n"
.'- Phone: 电话'."\n"
.'- Sms: 短信'."\n"
.'- Dingding: 钉钉webhook'."\n"
.'- Feishu: 飞书webhook'."\n"
.'- Weixin: 企业微信webhook'."\n"
.'- Webhook: 自定义Webhook', 'type' => 'string', 'required' => false, 'example' => 'Sms'],
'required' => true,
],
'Receivers' => [
'description' => '告警接收对象。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '告警接收对象类型，枚举值：'."\n"
.'- AliUid: 阿里云UID'."\n"
.'- ShiftSchedule: 值班表'."\n"
.'- TaskOwner: 任务责任人，适用于自定义告警和事件告警'."\n"
.'- Owner: 责任人，适用于基线告警'."\n"
.'- WebhookUrl: 自定义webhookUrl'."\n"
.'- DingdingUrl: 钉钉webhookUrl'."\n"
.'- FeishuUrl: 飞书webhookUrl'."\n"
.'- WeixinUrl: 企业微信webhookUrl', 'type' => 'string', 'required' => false, 'example' => 'TaskOwner'],
'ReceiverValues' => [
'description' => '告警接收对象值。',
'type' => 'array',
'items' => ['description' => '告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云UID，为 ShiftSchedule 时填值班表ID，为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', 'type' => 'string', 'required' => false, 'example' => '123123123'],
'required' => false,
],
'Extension' => ['description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 {"atAll":true} @所有人。', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n"],
],
'required' => false,
],
'required' => true,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的 ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946'."\n"],
'Id' => ['description' => '自定义规则。', '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' => '创建自定义监控告警规则',
'changeSet' => [],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID，'."\n"
.'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，'."\n"
.'即数据开发页面顶部切换工作空间处的英文标识。该参数与projectid参数二者必须设置其一，以确定本次API调用操作的DataWorks项目。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'BusinessName',
'in' => 'formData',
'schema' => ['description' => '业务流程名称，'."\n"
.'同一个项目空间下的业务流程名称必须唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'My business process'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '业务流程的描述信息'."\n"
.'。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '业务流程对应责任人的阿里云账号ID。'."\n"
.'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，鼠标悬停至顶部菜单栏右侧的用户头像，查看账号ID。如果该参数为空，则默认使用调用者的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => '1000000000001'],
],
[
'name' => 'UseType',
'in' => 'formData',
'schema' => [
'description' => '业务流程所属的功能模块。取值如下：'."\n"
."\n"
.'- NORMAL（数据开发）'."\n"
.'- MANUAL_BIZ（手动业务流程）',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [],
'example' => 'NORMAL',
'default' => 'NORMAL',
'enum' => ['NORMAL', 'MANUAL_BIZ'],
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '本次调用的唯一ID。'."\n"
.'出现错误后，您可以根据该id排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码。取值说明如下：'."\n"
.'- 请求成功：不返回ErrorCode字段。'."\n"
.'- 请求失败：返回ErrorCode字段。'."\n"
."\n"
.'具体信息，请参见本文的错误码列表。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'BusinessId' => ['description' => '业务流程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100001'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"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' => '创建业务流程',
'summary' => '调用CreateBusiness，创建数据开发（DataStudio）的业务流程。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateComponent' => [
'summary' => '创建组件。',
'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' => '数据源所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。', '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' => '保留字段。', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9****'],
],
],
'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' => 'adssd****'],
'ComponentId' => ['description' => '数据集加速组件ID。如何获取组件ID，请参见[ListComponents](~~2979566~~)。', 'type' => 'string', 'example' => '123123123123123'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建组件',
'description' => '>该接口目前不支持批量操作，参数中填写多个发布实体时，除第一个以外的部分会被直接忽略。>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"ComponentId\\": \\"123123123123123\\"\\n}","type":"json"}]',
],
'CreateComputeResource' => [
'summary' => '在指定项目空间创建一条计算资源，可以是开发环境或生产环境。',
'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' => 'Dataworks项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符', 'description' => '计算资源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符。', 'type' => 'string', 'required' => true, 'example' => 'demo_holo_cs'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['title' => '数据源的类型，目前已经支持数据源类型 70+', 'description' => '计算资源的类型，目前已经支持多种计算资源类型。', 'type' => 'string', 'required' => true, 'example' => 'hologres'],
],
[
'name' => 'ConnectionPropertiesMode',
'in' => 'query',
'schema' => [
'title' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以mysql数据源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）',
'description' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以Hologres计算资源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）。',
'type' => 'string',
'required' => true,
'example' => 'InstanceMode',
'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'],
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '数据源描述信息，长度不超过 3000 个字符', 'description' => '计算资源描述信息，长度不超过 3000 个字符。', 'type' => 'string', 'required' => false, 'example' => 'demo_holo_cs'],
],
[
'name' => 'ConnectionProperties',
'in' => 'query',
'schema' => ['title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。'."\n"
.'```'."\n", 'description' => '计算资源具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。', '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' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Id' => ['title' => '返回创建的数据源Id', 'description' => '返回创建的计算资源Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建计算资源',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。'."\n"
.'需要在 DataWorks 项目空间中具有如下至少一种角色：'."\n"
.'租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Id\\": 10001\\n}","type":"json"}]',
],
'CreateCustomAttribute' => [
'summary' => '创建自定义属性定义。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'description' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['title' => '自定义属性展示名称，长度小于128个字符', 'description' => '自定义属性展示名称，长度小于128个字符', 'type' => 'string', 'required' => true, 'example' => '业务负责人'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'title' => '自定义属性类型，支持 ENUM、TEXT、HYPERLINK',
'description' => '自定义属性类型，支持 ENUM、TEXT、HYPERLINK',
'type' => 'string',
'required' => true,
'example' => 'TEXT',
'enum' => ['ENUM', 'TEXT', 'HYPERLINK'],
],
],
[
'name' => 'EntityTypes',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'title' => '适用实体类型列表，支持精确实体类型以及 `*-table`、`*-column` 通配写法',
'description' => '适用实体类型列表，支持精确实体类型以及 `*-table`、`*-column` 通配写法，如'."\n"
.'- dataworks-project 工作空间'."\n"
.'- dataworks-dataset dataworks数据集'."\n"
.'- maxcompute-table maxcompute表'."\n"
.'- *-column 所有字段类型',
'type' => 'array',
'items' => ['description' => '实体类型', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table'],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'ValueEnums',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'title' => '枚举可选值，type=ENUM时必填；TEXT、HYPERLINK类型不支持',
'description' => '枚举可选值，type=ENUM时必填；TEXT、HYPERLINK类型不支持',
'type' => 'array',
'items' => ['description' => '枚举可选值', 'type' => 'string', 'required' => false, 'example' => 'VALUE_1'],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'DisplayEnabled',
'in' => 'formData',
'schema' => ['title' => '是否在页面展示，默认为true', 'description' => '是否在详情页展示，默认为true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SearchFilterEnabled',
'in' => 'formData',
'schema' => ['title' => '是否支持作为筛选条件，默认为false', 'description' => '是否支持在数据地图搜索页作为筛选条件，默认为false，目前仅ENUM类型配置该值为true', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '自定义属性描述，长度小于256个字符', 'description' => '自定义属性描述，长度小于256个字符', 'type' => 'string', 'required' => false, 'example' => 'test comment'],
],
],
'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' => '5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'Result' => ['title' => '创建结果', 'description' => '创建结果', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建自定义属性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]',
],
'CreateDIAlarmRule' => [
'summary' => '创建数据集成报警规则。',
'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' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'Alert description'],
],
[
'name' => 'MetricType',
'in' => 'query',
'schema' => [
'title' => '告警指标类型，可选的枚举值：'."\n"
.'- Heartbeat（任务状态报警）'."\n"
.'- FailoverCount（failover次数报警）'."\n"
.'- Delay（任务延迟报警）',
'description' => '告警指标类型，可选的枚举值：'."\n"
.'- Heartbeat（任务状态报警）'."\n"
.'- FailoverCount（failover次数报警）'."\n"
.'- Delay（任务延迟报警）'."\n"
.'- DdlReport（DDL通知）'."\n"
.'- ResourceUtilization（资源组使用率）',
'type' => 'string',
'required' => true,
'example' => 'Heartbeat',
'enum' => [],
],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['title' => '告警规则是否启用，默认不开启。', 'description' => '告警规则是否启用，默认不开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['title' => '任务ID，是告警规则关联的任务ID。', 'description' => '任务ID，是告警规则关联的任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '告警规则名称。', 'type' => 'string', 'required' => true, 'example' => 'alartRule'],
],
[
'name' => 'TriggerConditions',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警触发条件列表，支持多条件。',
'type' => 'array',
'items' => [
'description' => '告警触发条件列表，支持多条件。',
'type' => 'object',
'properties' => [
'Severity' => ['description' => '严重程度，可选的枚举值：'."\n"
.'- Warning'."\n"
.'- Critical', 'type' => 'string', 'required' => false, 'example' => 'Warning'],
'Duration' => ['description' => '告警计算时间区间，单位分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
'Threshold' => ['description' => '告警阈值。'."\n"
.'- 任务状态报警：无需填写阈值。'."\n"
.'- failover次数报警：阈值为failover次数。'."\n"
.'- 任务延迟报警：阈值为延迟时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
'DdlTypes' => [
'description' => '在DDL通知的时候才生效，需要生效的DDL列表。',
'type' => 'array',
'items' => ['description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表，包括 '."\n"
.'- AlterAddColumn 加列'."\n"
.' - AlterDropColumn 删列'."\n"
.' - AlterRenameColumn 修改列名'."\n"
.' - AlterRenameTable 修改表名'."\n"
.' - AlterTableModify 其他修改表'."\n"
.' - DropTable 删除表'."\n"
.' - TruncateTable 清空表', 'type' => 'string', 'required' => false, 'example' => 'AlterAddColumn'],
'required' => false,
],
'DdlReportTags' => [
'description' => '该字段已废弃，请使用DdlTypes字段。',
'type' => 'array',
'items' => ['description' => '该字段已废弃，请使用DdlTypes字段。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'AlterAddColumn'],
'deprecated' => true,
'required' => false,
],
],
'required' => false,
],
'required' => true,
],
],
[
'name' => 'NotificationSettings',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警通知设置。',
'type' => 'object',
'properties' => [
'NotificationChannels' => [
'description' => '告警通知渠道。',
'type' => 'array',
'items' => [
'description' => '告警通知渠道。',
'type' => 'object',
'properties' => [
'Severity' => ['description' => '严重程度，可选的枚举值：'."\n"
.'- Warning'."\n"
.'- Critical', 'type' => 'string', 'required' => false, 'example' => 'Warning'],
'Channels' => [
'description' => '通道，可选的枚举值：'."\n"
.'- Mail（邮件）'."\n"
.'- Phone（电话）'."\n"
.'- Sms（短信）'."\n"
.'- Ding（钉钉）',
'type' => 'array',
'items' => ['description' => '通道，可选的枚举值：'."\n"
.'- Mail（邮件）'."\n"
.'- Phone（电话）'."\n"
.'- Sms（短信）'."\n"
.'- Ding（钉钉）', 'type' => 'string', 'required' => false, 'example' => 'Ding'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'NotificationReceivers' => [
'description' => '告警通知接收方。',
'type' => 'array',
'items' => [
'description' => '告警通知接收方。',
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl', 'type' => 'string', 'required' => false, 'example' => 'DingToken'],
'ReceiverValues' => [
'description' => '接收方取值。'."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。',
'type' => 'array',
'items' => ['description' => '接收方取值。'."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', 'type' => 'string', 'required' => false, 'example' => 'token1'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'MuteInterval' => ['description' => '告警抑制间隔时长，单位分钟，默认5分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
'InhibitionInterval' => ['description' => '该字段已废弃，请使用MuteInterval进行配置。', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '5'],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Id' => ['description' => '告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'C636A747-7E4E-594D-94CD-2B****'],
'DIAlarmRuleId' => ['title' => '资源一级ID', 'description' => '该字段已废弃，请使用Id字段。', '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' => '创建数据集成同步任务告警规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateDIJob' => [
'summary' => '创建数据集成新版任务。',
'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' => '目标端数据源类型，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，LogHub，StarRocks，DataHub，AnalyticDB_For_MySQL，Kafka，Hive。', 'type' => 'string', 'required' => false, 'example' => 'Hologres'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '任务的描述', 'type' => 'string', 'required' => false, 'example' => 'DI Job Demo'],
],
[
'name' => 'SourceDataSourceType',
'in' => 'query',
'schema' => ['description' => '源端数据源类型，枚举值： PolarDB，MySQL，Kafka，LogHub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SQLServer，Doris，ClickHouse。', 'type' => 'string', 'required' => false, 'example' => 'MySQL'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'mysql_to_holo_sync_8772'],
],
[
'name' => 'MigrationType',
'in' => 'query',
'schema' => ['description' => '同步类型，可选的枚举值有：'."\n"
.'- FullAndRealtimeIncremental（全量和实时增量，整库实时）'."\n"
.'- RealtimeIncremental（实时增量，单表实时）'."\n"
.'- Full（全量，整库离线）'."\n"
.'- OfflineIncremental（离线增量，整库离线）'."\n"
.'- FullAndOfflineIncremental（全量+离线增量，整库离线）', 'type' => 'string', 'required' => false, 'example' => 'FullAndRealtimeIncremental'],
],
[
'name' => 'JobType',
'in' => 'query',
'schema' => ['description' => '任务类型，可选'."\n"
."\n"
.' - DatabaseRealtimeMigration(整库实时):将源端多个库的多个表进行流同步，支持仅全量，仅增量，或全量+增量。'."\n"
."\n"
.' - DatabaseOfflineMigration(整库离线):将源端多个库的多个表进行批同步，支持仅全量，仅增量，或全量+增量。'."\n"
."\n"
.' - SingleTableRealtimeMigration(单表实时):将源端单个表进行流同步', 'type' => 'string', 'required' => false, 'example' => 'DatabaseRealtimeMigration'],
],
[
'name' => 'SourceDataSourceSettings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '源端数据源设置列表',
'type' => 'array',
'items' => [
'description' => '单个源端数据源设置',
'type' => 'object',
'properties' => [
'DataSourceName' => ['description' => '数据源名称', 'type' => 'string', 'required' => false, 'example' => 'mysql_datasource_1'],
'DataSourceProperties' => [
'description' => '数据源属性',
'type' => 'object',
'properties' => [
'Encoding' => ['description' => '数据库编码', 'type' => 'string', 'required' => false, 'example' => 'UTF-8'],
'Timezone' => ['description' => '时区', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'],
'ConnectionProperties' => ['title' => '与DataSourceName数据源名称二选一填写；本参数为自定义数据源连接配置信息，包括实例id、访问身份、实例region等。', 'description' => '与DataSourceName数据源名称二选一填写；本参数为自定义数据源连接配置信息，包括实例id、访问身份、实例region等。'."\n"
."\n"
.'本参数仅支持数据源配置为实例模式（ConnectionPropertiesMode），不同数据源具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', 'type' => 'string', 'required' => false, 'example' => '{ "instanceId": "rm-2ze09gn3x6xxx", "password": "xxxx", "database": "agent", "username": "zmtest" "regionId": "cn-beijing" }'],
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'DestinationDataSourceSettings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '目标端数据源设置列表',
'type' => 'array',
'items' => [
'description' => '单个目标端数据源设置',
'type' => 'object',
'properties' => [
'DataSourceName' => ['description' => '数据源名称', 'type' => 'string', 'required' => false, 'example' => 'holo_datasource_1'],
'DataSourceProperties' => [
'description' => '数据源属性',
'type' => 'object',
'properties' => [
'ConnectionProperties' => ['title' => '与DataSourceName数据源名称二选一填写；本参数为自定义数据源连接配置信息，包括实例id、访问身份、实例region等。', 'description' => '与DataSourceName数据源名称二选一填写；本参数为自定义数据源连接配置信息，包括实例id、访问身份、实例region等。'."\n"
."\n"
.'本参数仅支持数据源配置为实例模式（ConnectionPropertiesMode），不同数据源具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', 'type' => 'string', 'required' => false, 'example' => '{ "instanceId": "rm-2ze09gn3x6xxx", "password": "xxxx", "database": "agent", "username": "zmtest" "regionId": "cn-beijing" }'],
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'ResourceSettings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '资源设置',
'type' => 'object',
'properties' => [
'OfflineResourceSettings' => [
'description' => '离线同步资源',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '离线同步使用的数据集成资源组cu', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
'ResourceGroupIdentifier' => ['description' => '离线同步使用的数据集成资源组名称', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222'],
],
'required' => false,
],
'RealtimeResourceSettings' => [
'description' => '实时同步资源',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '实时同步使用的数据集成资源组cu', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
'ResourceGroupIdentifier' => ['description' => '实时同步使用的数据集成资源组名称', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222'],
],
'required' => false,
],
'ScheduleResourceSettings' => [
'description' => '调度资源',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '离线同步任务使用的调度资源组cu', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
'ResourceGroupIdentifier' => ['description' => '离线同步任务使用的调度资源组名称', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_222_333'],
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'TransformationRules',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '同步对象转换规则定义列表'."\n"
.'>[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]',
'type' => 'array',
'items' => [
'description' => '单个同步对象转换规则定义，每个元素为一条转换规则定义',
'type' => 'object',
'properties' => [
'RuleActionType' => ['description' => '动作类型，可选的枚举值：'."\n"
."\n"
.'- DefinePrimaryKey（定义主键）'."\n"
.'- Rename（重命名）'."\n"
.'- AddColumn（增加列）'."\n"
.'- HandleDml（DML处理）'."\n"
.'- DefineIncrementalCondition（定义增量条件）'."\n"
.'- DefineCycleScheduleSettings（定义周期调度设置）'."\n"
.'- DefinePartitionKey（定义分区列）', 'type' => 'string', 'required' => false, 'example' => 'Rename'],
'RuleExpression' => ['description' => '规则表达式，json string格式。'."\n"
."\n"
.'1. 重命名规则（Rename）'."\n"
.'- 示例：{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }'."\n"
.'- expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n"
.'2. 加列规则（AddColumn)'."\n"
.'- 示例：{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n"
.'- 如不指定，默认规则为不加列不复制。'."\n"
.'- columnName：附加的列名称。'."\n"
.'- columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n"
.'- columnValue：附加的列取值。当columnValueType=Constant时，value为自定义常量，String类型。当columnValueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n"
.'3. 指定目标端表的主键列列名（DefinePrimaryKey）'."\n"
.'- 示例：{"columns":["ukcolumn1","ukcolumn2"]}'."\n"
.'- 如不指定默认使用源端主键列。'."\n"
.'- 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n"
.'- 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n"
.'4. DML处理规则（HandleDml）'."\n"
.'- 示例： {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\n"
.'- 如不指定，默认规则为Insert、Update、Delete均为Normal'."\n"
.'- dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n"
.'- dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n"
.'- filterCondition：DML过滤条件，当dmlAction=Filter时使用'."\n"
.'5. 增量条件（DefineIncrementalCondition）'."\n"
.'- 示例： {"where":"id > 0"}'."\n"
.'- 指定增量过滤条件'."\n"
.'6. 周期调度参数（DefineCycleScheduleSettings）'."\n"
.'- 示例： {"cronExpress":" * * * * * *", "cycleType":"1"}'."\n"
.'- 指定周期任务调度参数'."\n"
.'7. 指定分区键（DefinePartitionKey）'."\n"
.'- 示例： {"columns":["id"]}'."\n"
.'- 指定分区键', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "expression": "${srcDatasoureName}_${srcDatabaseName}"'."\n"
.'}'],
'RuleName' => ['description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性，长度不能超过50个字符', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1'],
'RuleTargetType' => ['description' => '动作作用的目标类型，可选的枚举值：'."\n"
."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'required' => false, 'example' => 'Table'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'TableMappings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表'."\n"
."\n"
.'> [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]',
'type' => 'array',
'items' => [
'description' => '每条规则代表选择需要同步的一个表',
'type' => 'object',
'properties' => [
'SourceObjectSelectionRules' => [
'description' => '每条规则可选择待同步源端对象的集合，多条规则组成选一个表',
'type' => 'array',
'items' => [
'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表',
'type' => 'object',
'properties' => [
'Action' => ['description' => '选择动作，取值范围：Include/Exclude', 'type' => 'string', 'required' => false, 'example' => 'Include'],
'Expression' => ['description' => '表达式', 'type' => 'string', 'required' => false, 'example' => 'mysql_table_1'],
'ExpressionType' => ['description' => '表达式类型，取值范围：Exact/Regex', 'type' => 'string', 'required' => false, 'example' => 'Exact'],
'ObjectType' => ['description' => '对象类型，可选的枚举值：'."\n"
."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'required' => false, 'example' => 'Table'],
],
'required' => false,
],
'required' => false,
],
'TransformationRules' => [
'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义',
'type' => 'array',
'items' => [
'description' => '源端对象上应用的转换规则',
'type' => 'object',
'properties' => [
'RuleName' => ['description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一，长度不能超过50个字符', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1'],
'RuleActionType' => ['description' => '动作类型，可选的枚举值：'."\n"
."\n"
.'- DefinePrimaryKey（定义主键）'."\n"
.'- Rename（重命名）'."\n"
.'- AddColumn（增加列）'."\n"
.'- HandleDml（DML处理）'."\n"
.'- DefineIncrementalCondition（定义增量条件）'."\n"
.'- DefineCycleScheduleSettings（定义周期调度设置）'."\n"
.'- DefinePartitionKey（定义分区列）', 'type' => 'string', 'required' => false, 'example' => 'Rename'],
'RuleTargetType' => ['description' => '动作作用的目标类型，可选的枚举值：'."\n"
."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'required' => false, 'example' => 'Table'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'JobSettings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '同步任务维度的设置，含DDL处理策略、源端和目标端列数据类型映射策略、任务运行时参数等',
'type' => 'object',
'properties' => [
'ChannelSettings' => ['description' => '通道相关任务设置，可以对一些特定通道进行特殊配置，目前支持Holo2Holo（从holo同步到holo），Holo2Kafka（从Holo同步到Kafka）'."\n"
."\n"
.'1. Holo2Kafka'."\n"
.'- 示例：{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}'."\n"
.'kafkaClientProperties：kafka producer参数，写入kafka时使用'."\n"
.'- keyColumns， 需要写入的kafka列取值'."\n"
.'- writeMode，kafka写入格式，目前支持json/canal'."\n"
.'2. Holo2Holo'."\n"
.'- 示例： {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n"
."\n"
.'- conflictMode: 写入holo冲突处理策略，replace-覆盖、ignore-忽略'."\n"
."\n"
.'- writeMode: 写入holo方式，replay-重放、insert-插入'."\n"
."\n"
.'- dynamicColumnAction：写入holo 动态列方式replay-重放、insert-插入，ignore-忽略', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "structInfo": "MANAGED",'."\n"
.' "storageType": "TEXTFILE",'."\n"
.' "writeMode": "APPEND",'."\n"
.' "partitionColumns": ['."\n"
.' {'."\n"
.' "columnName": "pt",'."\n"
.' "columnType": "STRING",'."\n"
.' "comment": ""'."\n"
.' }'."\n"
.' ],'."\n"
.' "fieldDelimiter": ""'."\n"
.'}'],
'ColumnDataTypeSettings' => [
'description' => '列类型映射数组'."\n"
."\n"
.'> ["ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]',
'type' => 'array',
'items' => [
'description' => '单条列类型映射',
'type' => 'object',
'properties' => [
'DestinationDataType' => ['description' => '目标端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', 'type' => 'string', 'required' => false, 'example' => 'text'],
'SourceDataType' => ['description' => '源端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', 'type' => 'string', 'required' => false, 'example' => 'bigint'],
],
'required' => false,
],
'required' => false,
],
'CycleScheduleSettings' => [
'description' => '周期调度设置',
'type' => 'object',
'properties' => [
'CycleMigrationType' => ['description' => '需要周期调度的同步类型。取值范围：'."\n"
."\n"
.'- Full：全量'."\n"
.'- OfflineIncremental：离线增量', 'type' => 'string', 'required' => false, 'example' => 'Full'],
'ScheduleParameters' => ['description' => '调度参数', 'type' => 'string', 'required' => false, 'example' => 'bizdate=$bizdate'],
],
'required' => false,
],
'DdlHandlingSettings' => [
'description' => 'DDL处理设置数组。'."\n"
."\n\n"
.'> ["DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]',
'type' => 'array',
'items' => [
'description' => '单条DDL处理设置',
'type' => 'object',
'properties' => [
'Action' => ['description' => '处理动作，可选的枚举值：'."\n"
."\n"
.'- Ignore（忽略）'."\n"
.'- Critical（报错）'."\n"
.'- Normal（正常处理）', 'type' => 'string', 'required' => false, 'example' => 'Critical'],
'Type' => ['description' => 'DDL类型，可选的枚举值：'."\n"
."\n"
.'- RenameColumn（重命名列）'."\n"
.'- ModifyColumn（重命名列）'."\n"
.'- CreateTable（重命名列）'."\n"
.'- TruncateTable（清空表）'."\n"
.'- DropTable（删除表）'."\n"
.'- DropColumn（删除列）'."\n"
.'- AddColumn（新增列）', 'type' => 'string', 'required' => false, 'example' => 'AddColumn'],
],
'required' => false,
],
'required' => false,
],
'RuntimeSettings' => [
'description' => '运行时设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '设置名称，可选的枚举值：'."\n"
."\n"
.'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n"
.'- dst.offline.truncate (是否清空目标表）'."\n"
.'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n"
.'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n"
.'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n"
.'- runtime.realtime.concurrent（实时任务并发度）'."\n"
.'- runtime.realtime.failover.minute.dataxcdc (failover失败重启等待时间单位分钟)'."\n"
.'- runtime.realtime.failover.times.dataxcdc (failover失败重启次数）', 'type' => 'string', 'required' => false, 'example' => 'runtime.offline.concurrent'."\n"],
'Value' => ['description' => '设置取值', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'JobName',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Name字段。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'mysql_to_holo_sync_8772'],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['title' => '任务责任人', 'description' => '任务责任人。', 'type' => 'string', 'required' => false, 'example' => '3726346'],
],
[
'name' => 'FileSpec',
'in' => 'formData',
'schema' => ['description' => '脚本模式代码内容。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "resourceSettings": {'."\n"
.' "realtimeResourceSettings": {'."\n"
.' "requestedCu": 2,'."\n"
.' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n"
.' },'."\n"
.' "offlineResourceSettings": {'."\n"
.' "requestedCu": 2,'."\n"
.' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n"
.' }'."\n"
.' },'."\n"
.' "tableMappings": ['."\n"
.' {'."\n"
.' "sourceObjectSelectionRules": ['."\n"
.' {'."\n"
.' "expression": "autotest_hologres",'."\n"
.' "action": "Include",'."\n"
.' "expressionType": "Exact",'."\n"
.' "objectType": "Datasource"'."\n"
.' },'."\n"
.' {'."\n"
.' "expression": "auto_holo_2661647",'."\n"
.' "action": "Include",'."\n"
.' "expressionType": "Exact",'."\n"
.' "objectType": "Table"'."\n"
.' },'."\n"
.' {'."\n"
.' "expression": "public",'."\n"
.' "action": "Include",'."\n"
.' "expressionType": "Exact",'."\n"
.' "objectType": "Schema"'."\n"
.' }'."\n"
.' ],'."\n"
.' "transformationRules": ['."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "SourceSchema",'."\n"
.' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Schema",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "DefineDstTableSettings",'."\n"
.' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "ColumnMapping",'."\n"
.' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ],'."\n"
.' "sourceDataSourceSettings": ['."\n"
.' {'."\n"
.' "dataSourceProperties": {'."\n"
.' "timeZone": "Asia/Shanghai"'."\n"
.' },'."\n"
.' "dataSourceName": "autotest_hologres"'."\n"
.' }'."\n"
.' ],'."\n"
.' "jobSettings": {'."\n"
.' "runtimeSettings": ['."\n"
."\n"
.' ],'."\n"
.' "ddlHandlingSettings": ['."\n"
."\n"
.' ],'."\n"
.' "columnDataTypeSettings": ['."\n"
."\n"
.' ],'."\n"
.' "cycleScheduleSettings": {'."\n"
."\n"
.' },'."\n"
.' "channelSettings": {'."\n"
.' "destinationChannelSettings": {'."\n"
.' "conflictMode": "replace",'."\n"
.' "dynamicColumnAction": "replay",'."\n"
.' "writeMode": "replay"'."\n"
.' },'."\n"
.' "sourceChannelSettings": {'."\n"
."\n"
.' }'."\n"
.' }'."\n"
.' },'."\n"
.' "destinationDataSourceType": "Hologres",'."\n"
.' "transformationRules": ['."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe",'."\n"
.' "ruleActionType": "SourceSchema",'."\n"
.' "ruleExpression": {'."\n"
.' "columns": ['."\n"
.' {'."\n"
.' "name": "id",'."\n"
.' "category": "normal",'."\n"
.' "type": "BIGINT"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "decimal",'."\n"
.' "category": "normal",'."\n"
.' "type": "DECIMAL"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Schema",'."\n"
.' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleExpression": {'."\n"
.' "expression": "public"'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleExpression": {'."\n"
.' "expression": "auto_holo_2661647_dst"'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi",'."\n"
.' "ruleActionType": "DefineDstTableSettings",'."\n"
.' "ruleExpression": {'."\n"
.' "ddlString": "BEGIN;'."\n"
.'CREATE TABLE IF NOT EXISTS public.auto_holo_2661647_dst ('."\n"
.' id BIGINT PRIMARY KEY,'."\n"
.' "decimal" DECIMAL(38,18)'."\n"
.');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'time_to_live_in_seconds\', \'3153600000\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'orientation\', \'column\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.level\', \'replica\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.ttl\', \'2592000\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'bitmap_columns\', \'"text","char","varchar"\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'dictionary_encoding_columns\', \'"text":auto,"bytea":auto,"char":auto,"varchar":auto\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'distribution_key\', \'"id"\');'."\n"
.'COMMIT;'."\n"
.'",'."\n"
.' "ddlType": "STRUCT"'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo",'."\n"
.' "ruleActionType": "ColumnMapping",'."\n"
.' "ruleExpression": {'."\n"
.' "columnMapping": ['."\n"
.' {'."\n"
.' "sourceColName": "id",'."\n"
.' "dstColName": "id"'."\n"
.' },'."\n"
.' {'."\n"
.' "sourceColName": "decimal",'."\n"
.' "dstColName": "decimal"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ],'."\n"
.' "migrationType": "FullAndRealtimeIncremental",'."\n"
.' "destinationDataSourceSettings": ['."\n"
.' {'."\n"
.' "dataSourceProperties": {'."\n"
."\n"
.' },'."\n"
.' "dataSourceName": "autotest_hologres"'."\n"
.' }'."\n"
.' ],'."\n"
.' "sourceDataSourceType": "Hologres"'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据集成任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '11792'],
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB'],
'DIJobId' => ['description' => '该字段已废弃，请使用Id字段。', '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' => '创建数据集成同步任务',
'description' => '- 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'- 该接口创建了数据集成同步任务，'."\n"
.'参数包括同步任务的源端配置SourceDataSourceSettings和目的端配置DestinationDataSourceSettings，以及支持的同步类型MigrationType，同时通过TransformationRules定义了对同步表做的如加列，表名替换等映射rule，在TableMappings中定义了要同步的具体表以及表需要使用的映射rule，在JobSettings中定义了任务的列映射和周期设置等。',
'changeSet' => [
['createdAt' => '2025-03-27T08:15:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T05:34:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateDataAssetTag' => [
'summary' => '创建标签。',
'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' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key1', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
'name' => 'Values',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签值列表。',
'type' => 'array',
'items' => ['description' => '标签值。', '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' => '标签描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description', 'maxLength' => 1024, 'minLength' => 0],
],
[
'name' => 'ValueType',
'in' => 'query',
'schema' => [
'description' => '标签值类型。'."\n"
.'- Boolean'."\n"
.'- Int'."\n"
.'- String'."\n"
.'- Double',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'String',
'enum' => ['Boolean', 'Int', 'String', 'Double'],
],
],
[
'name' => 'Managers',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签管理员列表。',
'type' => 'array',
'items' => ['description' => '标签管理员。', 'type' => 'string', 'required' => false, 'example' => '12345'],
'required' => false,
'maxItems' => 20,
'minItems' => 0,
],
],
],
'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' => '调用是否成功。', '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建标签',
'description' => '需要购买DataWorks企业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateDataQualityAlertRule' => [
'summary' => '用于在指定项目中创建数据质量监控告警规则。',
'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' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'Condition',
'in' => 'formData',
'schema' => ['description' => '数据质量监控告警规则告警条件。', 'type' => 'string', 'required' => true, 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }'],
],
[
'name' => 'Target',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控告警规则关注目标。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '监控对象的类型，只支持 DataQualityScan。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'DataQualityScan',
],
'Ids' => [
'description' => '监控目标ID列表，目前只支持设置一个。',
'type' => 'array',
'items' => ['description' => '监控目标ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '113646'],
'required' => true,
],
],
'required' => true,
],
],
[
'name' => 'Notification',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '告警渠道列表。',
'type' => 'object',
'properties' => [
'Channels' => [
'description' => '渠道列表，除了可以同时设置 `Email` 和 `Sms` 外，其他的情况都只能设置一种渠道。'."\n",
'type' => 'array',
'items' => [
'description' => '告警通道。'."\n"
.'- Dingding'."\n"
.'- Weixin'."\n"
.'- Mail'."\n"
.'- Sms'."\n"
.'- Phone'."\n"
.'- Webhook'."\n"
.'- Feishu',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Sms',
'enum' => ['Dingding', 'Weixin', 'Mail', 'Sms', 'Phone', 'Webhook', 'Feishu'],
],
'required' => true,
],
'Receivers' => [
'description' => '告警接收对象。',
'type' => 'array',
'items' => [
'description' => '告警接收对象。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置`{"atAll":true}`@所有人。', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n"],
'ReceiverType' => [
'description' => '告警接收对象类型。'."\n"
.'- AliUid'."\n"
.'- WebhookUrl'."\n"
.'- DingdingUrl'."\n"
.'- WeixinUrl'."\n"
.'- FeishuUrl'."\n"
.'- TaskOwner'."\n"
.'- DataQualityScanOwner'."\n"
.'- ShiftSchedule',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'TaskOwner',
'enum' => ['AliUid', 'WebhookUrl', 'DingdingUrl', 'WeixinUrl', 'FeishuUrl', 'TaskOwner', 'DataQualityScanOwner', 'ShiftSchedule'],
],
'ReceiverValues' => [
'description' => '告警接收对象值。',
'type' => 'array',
'items' => ['description' => '告警接收对象值。'."\n"
.'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n"
.'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n"
.'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', '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' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'Id' => ['description' => '创建自定义监控规则成功后，返回的自定义规则 ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1010543619'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建数据质量告警规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 1010543619\\n}","type":"json"}]',
],
'CreateDataQualityEvaluationTask' => [
'summary' => '创建DataWorks数据质量监控。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'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' => '数据质量监控对象',
'type' => 'object',
'properties' => [
'DatabaseType' => [
'title' => '表所属的数据库类型',
'description' => '表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- hologres'."\n"
.'- cdh'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks'."\n"
.'- emr'."\n"
.'- analyticdb_for_postgresql',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [],
'example' => 'maxcompute',
],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.api_test.ods_openapi_log_d'],
'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => '分区表的分区设置', 'type' => 'string', 'required' => false, 'example' => 'pt=$[yyyymmdd-1]', 'maxLength' => 255],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '质量监控任务描述', 'description' => '质量监控任务描述', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI create a data quality monitoring test', 'maxLength' => 65535],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '质量监控任务名称', 'description' => '质量监控任务名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OpenAPI create a data quality monitoring test'."\n", 'maxLength' => 255],
],
[
'name' => 'RuntimeConf',
'in' => 'formData',
'schema' => ['title' => '扩展配置', 'description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n"
.'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n"
.'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n"
.' + HIVE_SQL'."\n"
.' + SPARK_SQL', 'type' => 'string', 'required' => false, 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'],
],
[
'name' => 'Trigger',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '数据质量校验任务的触发配置',
'description' => '数据质量校验任务的触发配置',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '质量监控任务触发类型',
'description' => '质量监控触发类型：'."\n"
.'- ByManual：手动触发，默认值'."\n"
.'- ByScheduledTaskInstance：关联调度任务触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'ByScheduledTaskInstance',
],
'TaskIds' => [
'title' => '调度任务Ids',
'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效',
'type' => 'array',
'items' => ['description' => '调度任务Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30001'],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['title' => '项目空间Id', 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'],
],
[
'name' => 'Hooks',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '回调设置',
'description' => '回调设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => 'Hook类型',
'description' => 'Hook类型，目前只支持一种：'."\n"
.'- BlockTaskInstance：阻塞调度任务继续运行，数据质量监控是由调度任务触发的，那么在数据质量监控运行完成之后，会根据Hook.Condition来判断是否阻塞调度任务继续运行。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'BlockTaskInstance',
],
'Condition' => ['title' => 'Hook触发条件', 'description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n"
.'1. 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n"
.'2. 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => '通知订阅配置',
'type' => 'object',
'properties' => [
'Condition' => ['title' => '通知触发条件', 'description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n"
."\n"
.'只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n"
.'指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => '通知设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NotificationReceivers' => [
'title' => '告警接收人设置',
'description' => '告警接收人设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => [
'title' => '告警接收人类型',
'description' => '告警接收人类型'."\n"
.'- WebhookUrl：自定义webhook地址'."\n"
.'- FeishuUrl：飞书告警地址'."\n"
.'- DingdingUrl：钉钉告警地址'."\n"
.'- WeixinUrl：企业微信告警地址'."\n"
.'- AliUid：阿里云用户ID',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'DingdingUrl',
],
'Extension' => ['title' => '扩展信息', 'description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n"
.'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。', 'type' => 'string', 'required' => false, 'example' => '{ "atAll": true }'],
'ReceiverValues' => [
'title' => '告警接收人',
'description' => '告警接收人',
'type' => 'array',
'items' => [
'description' => '接收方取值。'."\n"
."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n"
.'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n"
.'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n"
.'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'https://api.fc.aliyuncs.com/webhook',
'maxLength' => 255,
],
'required' => false,
],
],
'required' => false,
'description' => '告警接收人设置',
],
'required' => false,
],
'NotificationChannels' => [
'title' => '通知方式',
'description' => '通知方式',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Channels' => [
'title' => '通知方式',
'description' => '通知方式',
'type' => 'array',
'items' => [
'description' => '告警方式'."\n"
.'- Mail - 邮件'."\n"
.'- Sms - 短信'."\n"
.'- Phone - 电话'."\n"
.'- Feishu - 飞书'."\n"
.'- Weixin - 微信'."\n"
.'- Dingding - 钉钉'."\n"
.'- Webhook - 自定义Webhook',
'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' => '数据源ID，您可以调用[ListDataSources](~~211431~~)获取数据源的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'DataQualityRules',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控关联的数据质量规则列表。如果设置了DataQualityRule.Id，则把Id对应的规则关联到新建质量监控中；如果没有设置，则用其他字段创建一个新的规则，关联到新建的质量监控中。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据质量规则名称。', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI test rules', 'default' => '255'],
'Enabled' => ['description' => '质量规则是否启用', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Severity' => [
'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n"
.'- Normal'."\n"
.'- High',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'High',
'enum' => ['High', 'Normal'],
],
'Description' => ['description' => '数据质量规则描述。', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI test rules'."\n", 'maxLength' => 500],
'TemplateCode' => ['description' => '规则所引用的规则模板唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM:field:null_value:fixed:0'],
'SamplingConfig' => [
'description' => '样本采集时，所需的参数。',
'type' => 'object',
'properties' => [
'Metric' => [
'description' => '采样的指标名称'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'NullValueCount',
],
'MetricParameters' => ['description' => '样本采集时，所需的参数', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'type' => 'string', 'required' => false, 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', 'maxLength' => 1000],
'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'type' => 'string', 'required' => false, 'example' => 'status != \'Succeeded\''],
],
'required' => false,
],
'CheckingConfig' => [
'description' => '样本校验设置',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '阈值计算方式'."\n"
."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Fixed',
],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'required' => false, 'example' => '{"bizdate": ["-1"]}'],
'Thresholds' => [
'description' => '校验阈值设置。',
'type' => 'object',
'properties' => [
'Expected' => [
'description' => '期望的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => [
'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '=',
],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'required' => false, 'example' => '0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'],
],
'required' => false,
],
'Warned' => [
'description' => '普通警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => [
'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '>',
],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'required' => false, 'example' => '0.001'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'],
],
'required' => false,
],
'Critical' => [
'description' => '严重警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => [
'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '>',
],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'required' => false, 'example' => '0.01'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'],
],
'required' => false,
],
],
'required' => false,
],
],
'required' => false,
],
'ErrorHandlers' => [
'description' => '质量规则校验问题处理器列表。',
'type' => 'array',
'items' => [
'description' => '质量规则校验问题处理器。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '处理器类型：'."\n"
."\n"
.'- SaveErrorData：保留问题数据',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'SaveErrorData',
],
'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', 'type' => 'string', 'required' => false, 'example' => 'SELECT * FROM ods_api_log WHERE status = \'Error\';'],
],
'required' => false,
],
'required' => false,
],
'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2176'],
],
'required' => false,
'description' => '',
],
'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' => '2d9ce-38ef-4923-baf6-391a7e656'],
'Id' => ['description' => '新建的数据质量监控ID。', '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.', 'description' => ''],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'],
],
'title' => '创建数据质量监控',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-27T06:36:24.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2d9ce-38ef-4923-baf6-391a7e656\\",\\n \\"Id\\": 10001\\n}","type":"json"}]',
],
'CreateDataQualityEvaluationTaskInstance' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '250253',
'abilityTreeNodes' => ['FEATUREdideGK4B66'],
],
'parameters' => [
[
'name' => 'DataQualityEvaluationTaskId',
'in' => 'formData',
'schema' => ['description' => '数据质量校验任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2000011'],
],
[
'name' => 'RuntimeResource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '资源组信息，运行非MaxCompute数据质量校验时需要填写。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'required' => false, 'example' => '63900680'],
'Cu' => ['description' => '任务运行配置CU消耗，如果使用了Serverless资源组，需要指定这个参数。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.25'],
],
'required' => false,
],
],
[
'name' => 'Parameters',
'in' => 'formData',
'schema' => ['description' => '数据质量校验执行参数，JSON格式，可用的key如下：'."\n"
.'- triggerTime：触发时间的毫秒时间戳，数据质量监控的数据范围中$[yyyymmdd]表达式的基准时间，必填。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "triggerTime": 1733284062000 }'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', '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' => '数据质量监控实例ID。', '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.', 'description' => ''],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScanRun'],
],
'title' => '创建数据质量校验监控实例',
'summary' => '创建数据质量校验任务实例。',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]',
],
'CreateDataQualityRule' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247801',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => true, 'example' => 'The table cannot be empty.', 'maxLength' => 255],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10726'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '质量规则是否启用。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
'name' => 'Severity',
'in' => 'formData',
'schema' => [
'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n"
.'- Normal'."\n"
.'- High',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
'default' => 'Normal',
'enum' => ['High', 'Normal'],
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '规则描述信息，最长500个字符。', 'type' => 'string', 'required' => false, 'example' => 'this is a odps _sql task'."\n", 'maxLength' => 500],
],
[
'name' => 'Target',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '规则所监控的对象。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型。'."\n"
."\n"
.'- Table', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Table'],
'DatabaseType' => ['description' => '表类型的数据集，表所属的数据库类型。'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'maxcompute'."\n"],
'TableGuid' => ['description' => '规则所作用的表在数据地图中的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.unit_test.tb_unit_test'."\n"],
'PartitionSpec' => ['description' => '分区表的分区设置。', 'type' => 'string', 'required' => false, 'example' => 'ds=$[yyyymmdd-1]'."\n"],
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'TemplateCode',
'in' => 'formData',
'schema' => ['description' => '规则所引用的规则模板唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SYSTEM:table:table_count:fixed', 'default' => 'SYSTEM:user_defined_sql'],
],
[
'name' => 'SamplingConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '样本采集所需的设置。',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称，使用模版时可不设置。'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'required' => false, 'example' => 'Count'],
'MetricParameters' => ['description' => '样本采集时，所需的参数。', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', 'type' => 'string', 'required' => false, 'example' => 'SET odps.sql.udf.timeout=600s; '."\n"
.'SET odps.sql.python.version=cp27;', 'maxLength' => 1000],
'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符。', 'type' => 'string', 'required' => false, 'example' => 'id IS NULL'."\n"],
],
'required' => false,
],
],
[
'name' => 'CheckingConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '样本校验设置。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式，使用模版时可不设置。'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'required' => false, 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n"],
'Thresholds' => [
'description' => '阈值设置。',
'type' => 'object',
'properties' => [
'Expected' => [
'description' => '期望的阈值设置。',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'required' => false, 'example' => '>'],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'required' => false, 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'required' => false, 'example' => '$checkValue <= 0.01'],
],
'required' => false,
],
'Warned' => [
'description' => '普通警告的阈值设置。',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'required' => false, 'example' => '>'],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'required' => false, 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'."\n"],
],
'required' => false,
],
'Critical' => [
'description' => '严重警告的阈值设置。',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'required' => false, 'example' => '>'],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'required' => false, 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.05'],
],
'required' => false,
],
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'ErrorHandlers',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '质量规则校验问题处理器列表。',
'type' => 'array',
'items' => [
'description' => '质量规则校验问题处理器。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '处理器类型：'."\n"
.'- SaveErrorData', 'type' => 'string', 'required' => false, 'example' => 'SaveErrorData'],
'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', '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' => '返回值。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID。', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"],
'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '19715'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'],
],
'title' => '创建质量规则',
'summary' => '创建质量规则。',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'extraInfo' => '规则模版Code列表：'."\n"
.'- 自定义SQL：SYSTEM:user_defined_sql'."\n"
."\n"
.'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n"
.'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n"
.'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n"
.'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n"
.'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n"
.'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n"
.'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n"
.'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n"
.'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n"
.'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n"
.'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n"
.'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n"
.'- 表行数，自定义范围：SYSTEM:table:count'."\n"
.'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n"
."\n"
.'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n"
.'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n"
.'- 平均值，自定义范围：SYSTEM:field:avg'."\n"
."\n"
.'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n"
.'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n"
.'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n"
.'- 汇总值，自定义范围：SYSTEM:field:sum'."\n"
."\n"
.'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n"
.'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n"
.'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n"
.'- 最小值，自定义范围：SYSTEM:field:min'."\n"
."\n"
.'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n"
.'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n"
.'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n"
.'- 最大值，自定义范围：SYSTEM:field:max'."\n"
."\n"
.'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n"
.'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n"
.'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n"
."\n"
.'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n"
.'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n"
.'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n"
.'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n"
."\n"
.'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n"
.'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n"
.'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n"
.'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n"
."\n"
.'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n"
.'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n"
.'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n"
.'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n"
.'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n"
.'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n"
."\n"
.'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n"
.'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n"
.'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n"
."\n"
.'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n"
.'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n"
.'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n"
.'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n"
.'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Id\\": 19715\\n}","type":"json"}]',
],
'CreateDataQualityRuleTemplate' => [
'summary' => '创建规则模版。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248081',
'abilityTreeNodes' => ['FEATUREdideRGVRPF'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Table row Count Verification'."\n", 'maxLength' => 128],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345'],
],
[
'name' => 'VisibleScope',
'in' => 'formData',
'schema' => [
'description' => '模板的可用范围：'."\n"
.'- Tenant：全租户都可用'."\n"
.'- Project：只在当前项目中可用',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => [],
'example' => 'Project',
'default' => 'Project',
'enum' => ['Project', 'Tenant'],
],
],
[
'name' => 'DirectoryPath',
'in' => 'formData',
'schema' => ['description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线。', 'type' => 'string', 'required' => false, 'example' => '/ods/order_data'."\n"],
],
[
'name' => 'SamplingConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '样本采集所需的设置。',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称：'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Count'],
'MetricParameters' => ['description' => '样本采集时，所需的参数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"SQL": "select count(1) from table;"}'."\n"],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', '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' => '样本校验设置。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式：'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n"],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID。', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"],
'Code' => ['description' => '规则模板Code。', 'type' => 'string', 'example' => 'UserDefined:3001'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityTemplate'],
'returnType' => 'synchronous',
],
'title' => '创建质量规则模板',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Code\\": \\"UserDefined:3001\\"\\n}","type":"json"}]',
],
'CreateDataQualityScan' => [
'summary' => '创建数据质量监控。',
'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' => '数据质量监控描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Daily data quality scanning of ods tables.'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/overview)，进入工作空间配置页面获取工作空间ID。需要用该参数来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '数据质量监控负责人用户ID。', 'type' => 'string', 'required' => false, 'example' => '95279527****'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '数据质量监控的内容的Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "datasets": ['."\n"
.' {'."\n"
.' "type": "Table",'."\n"
.' "dataSource": {'."\n"
.' "name": "odps_first",'."\n"
.' "envType": "Prod"'."\n"
.' },'."\n"
.' "tables": ['."\n"
.' "ods_d_user_info"'."\n"
.' ],'."\n"
.' "filter": "pt = $[yyyymmdd-1]"'."\n"
.' }'."\n"
.' ],'."\n"
.' "rules": ['."\n"
.' {'."\n"
.' "assertion": "row_count > 0"'."\n"
.' }, {'."\n"
.' "templateId": "SYSTEM:field:null_value:fixed",'."\n"
.' "pass": "when = 0",'."\n"
.' "name": "The id cannot be empty.",'."\n"
.' "severity": "High",'."\n"
.' "identity": "a-customized-data-quality-rule-uuid"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
[
'name' => 'Parameters',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控执行参数定义。',
'type' => 'array',
'items' => [
'description' => '数据质量监控执行参数定义。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '参数值。', 'type' => 'string', 'required' => false, 'example' => '$[yyyymmdd-1]'],
'Name' => ['description' => '参数名。', 'type' => 'string', 'required' => false, 'example' => 'triggerTime'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'RuntimeResource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控运行时，使用的资源组。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => '0525242e-d0ee-4bda-bc73-765d82f6a34a'],
'Cu' => ['description' => '运行配置CU消耗。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25'],
'Image' => ['description' => '运行配置的镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx'],
],
'required' => false,
],
],
[
'name' => 'ComputeResource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '计算引擎名字，唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'emr_first'],
'Runtime' => [
'description' => '数据质量监控在运行时的更多设置。',
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。'."\n"
.'取值范围：'."\n"
.'- Hive：Hive SQL'."\n"
.'- Spark：Spark SQL'."\n"
.'- Kyuubi',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Hive',
],
'SparkConf' => ['description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', 'type' => 'object', 'required' => false, 'example' => 'spark.yarn.queue=dq_queue'],
'HiveConf' => ['description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', 'type' => 'object', 'required' => false, 'example' => 'mapreduce.job.queuename=dq_queue'],
],
'required' => false,
],
'EnvType' => [
'description' => '计算引擎所属的工作空间环境。取值范围：'."\n"
.'- Prod：生产环境'."\n"
.'- Dev：开发环境',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Dev',
'enum' => ['Prod', 'Dev'],
],
],
'required' => false,
],
],
[
'name' => 'Trigger',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控触发设置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '数据质量监控触发方式。取值范围：'."\n"
.'- ByManual：手动触发，默认设置'."\n"
.'- BySchedule：调度任务实例触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'BySchedule',
],
'TaskIds' => [
'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。',
'type' => 'array',
'items' => ['description' => '调度任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1004979033'],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'Hooks',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'array',
'items' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'object',
'properties' => [
'Condition' => ['description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n"
."\n"
.'指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => 'Hook类型。取值范围：'."\n"
.'- BlockTaskInstance：阻塞任务实例调度',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'BlockTaskInstance',
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '数据质量监控名称。', 'type' => 'string', 'required' => false, 'example' => 'data_quality_scan_001'],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等参数。', 'type' => 'string', 'required' => true, 'example' => 'a-customized-uuid'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'Id' => ['description' => '返回创建的数据源分享规则ID，数据源分享规则的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '676303114031776'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建数据质量监控',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Id\\": 676303114031776\\n}","type":"json"}]',
],
'CreateDataQualityScanRun' => [
'summary' => '触发指定数据质量监控任务的执行，并返回运行实例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' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20000001'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Parameters',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '实际运行时，使用的参数设置，其中必传参数`triggerTime`。',
'type' => 'array',
'items' => [
'description' => '实际运行时，使用的参数设置。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '参数值：'."\n"
.'- 当参数名为triggerTime时，参数值应为调度时间的时间戳', 'type' => 'string', 'required' => false, 'example' => '1775812636'],
'Name' => ['description' => '参数名，目前支持参数为：'."\n"
.'- triggerTime'."\n"
."\n"
.'暂不支持其它调度参数', 'type' => 'string', 'required' => false, 'example' => 'triggerTime'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'RuntimeResource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控运行时，所使用的调度资源组，与调度API共用相同的数据结构。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'e9455a13-ff00-4965-833c-337546ba4854'],
'Cu' => ['description' => '资源组运行数据质量监控时预留的CU配置。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25'],
'Image' => ['description' => '使用资源组运行数据质量监控时的镜像设置。', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'Id' => ['description' => '被触发成功的RunId。', 'type' => 'integer', 'format' => 'int64', 'example' => '248840'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建数据质量扫描运行',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 248840\\n}","type":"json"}]',
],
'CreateDataQualityTemplate' => [
'summary' => '用于在指定项目中创建新的数据质量规则模板。',
'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' => '项目ID'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '规则模板详细配置Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "assertion": "anomaly detection fro id_not_null_cnt",'."\n"
.' "id_not_null_cnt": {'."\n"
.' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n"
.' },'."\n"
.' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n"
.'}'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '负责人的ID。', 'type' => 'string', 'required' => false, 'example' => '1000000000001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'Id' => ['description' => '新建的规则模板的唯一标识。', 'type' => 'string', 'example' => 'USER-DEFINED:2001'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建数据质量规则模板',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": \\"USER-DEFINED:2001\\"\\n}","type":"json"}]',
],
'CreateDataSource' => [
'summary' => '在指定项目空间创建一条数据源，可以是开发环境或生产环境。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/overview)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '2'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符', 'description' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符。', 'type' => 'string', 'required' => true, 'example' => 'demo_holo_datasource'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['title' => '数据源的类型，目前已经支持数据源类型 70+', 'description' => '数据源的类型，目前已经支持数据源类型 70+，数据源类型枚举说明参考文档：[数据源类型列表](~~2852465~~)', 'type' => 'string', 'required' => true, 'example' => 'hologres'],
],
[
'name' => 'ConnectionPropertiesMode',
'in' => 'query',
'schema' => [
'title' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以mysql数据源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）',
'description' => '数据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以MySQL数据源举例有：'."\n"
.'- InstanceMode（实例模式）'."\n"
.'- UrlMode（连接串模式）',
'type' => 'string',
'required' => true,
'example' => 'UrlMode',
'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'],
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '数据源描述信息，长度不超过 3000 个字符', 'description' => '数据源描述信息，长度不超过 3000 个字符。', 'type' => 'string', 'required' => false, 'example' => 'this is a holo datasource'],
],
[
'name' => 'ConnectionProperties',
'in' => 'query',
'schema' => ['title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。'."\n"
.'```'."\n", 'description' => '数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境envType信息是此对象的成员属性，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）'."\n"
."\n"
.'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
.' "envType": "Prod",'."\n"
.' "regionId": "cn-beijing",'."\n"
.' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n"
.' "database": "testdb",'."\n"
.' "securityProtocol": "authTypeNone",'."\n"
.' "authType": "Executor",'."\n"
.' "authIdentity": "1107550004253538"'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'B62EC203-B39E-5DC1-B5B8-EB3C6****'],
'Id' => ['title' => '返回创建的数据源Id', 'description' => '返回创建的数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '22130'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建数据源',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:CreateDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B62EC203-B39E-5DC1-B5B8-EB3C6****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]',
],
'CreateDataSourceSharedRule' => [
'summary' => '创建一条数据源分享规则，即将数据源分享给其他空间或者子账号使用。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '235541',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'DataSourceId',
'in' => 'query',
'schema' => ['description' => '数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '144544'],
],
[
'name' => 'TargetProjectId',
'in' => 'query',
'schema' => ['description' => '数据源分享到的目标项目空间ID，不支持分享到本项目。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '106560'],
],
[
'name' => 'SharedUser',
'in' => 'query',
'schema' => ['description' => '如果指定了SharedUser则表示分享到指定人，而不是到整个项目；不指定表示分享到整个项目。', 'type' => 'string', 'required' => false, 'example' => '110755000****'],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => ['description' => '数据源分享到目标项目空间环境，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）', 'type' => 'string', 'required' => true, 'example' => 'Dev'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '46F594E6-84AB-5FA5-8144-6F3D149961E1'],
'Id' => ['description' => '返回创建的数据源分享规则ID，数据源分享规则的唯一标识符。', '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' => '创建数据源分享规则',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 操作人需要将数据源从A空间分享到B空间，则需要操作人在A、B空间均具有数据源分享的权限点。需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、租户管理员、空间管理员、项目所有者',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:CreateDataSourceSharedRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateDataset' => [
'summary' => '创建数据集，仅支持在用户已加入的工作空间创建数据集'."\n"
.'且当前仅支持创建DataWorks数据集，单租户下限制数据集最大数量为2000',
'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' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Origin',
'in' => 'formData',
'schema' => [
'title' => '数据集来源，当前仅支持DataWorks',
'description' => '数据集来源，当前仅支持DataWorks',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DataWorks' => 'DataWorks'],
'example' => 'DataWorks',
'default' => 'DataWorks',
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '数据集名称，非空字符串，长度不超过128', 'description' => '数据集名称，非空字符串，长度不超过128', 'type' => 'string', 'required' => true, 'example' => 'test_oss_dataset'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '数据集描述,长度不超过1024', 'description' => '数据集描述,长度不超过1024', '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' => '数据类型，取值有'."\n"
.'- COMMON 通用（默认）'."\n"
.'- PIC 图片'."\n"
.'- TEXT 文本'."\n"
.'- TABLE 表格'."\n"
.'- VIDEO 视频'."\n"
.'- AUDIO 音频'."\n"
.'- INDEX 索引',
'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' => '存储类型，当前支持的取值有'."\n"
.'- OSS 对象存储'."\n"
.'- NAS 通用型NAS文件存储'."\n"
.'- EXTREMENAS 极速型NAS文件存储'."\n"
.'- DLF_LANCE 数据湖构建',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['NAS' => '通用型NAS文件存储', 'EXTREMENAS' => '极速型NAS文件存储', 'OSS' => '对象存储', 'DLF_LANCE' => '数据湖构建'],
'example' => 'OSS',
],
],
[
'name' => 'InitVersion',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '数据集初始版本',
'description' => '数据集初始版本',
'type' => 'object',
'properties' => [
'Comment' => ['title' => '描述，长度不超过1024', 'description' => '描述，长度不超过1024', 'type' => 'string', 'required' => false, 'example' => 'Initial Version'],
'Url' => ['title' => 'URL地址', 'description' => 'URL地址', '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' => '数据集的存储导入配置, 对于不同存储类型，需要的配置信息不同'."\n"
.''."\n"
.'NAS
'."\n"
.'取值可参考文件存储 API DescribeFileSystems 的返回信息'."\n"
."\n"
.'```JSON'."\n"
.'{'."\n"
.' "fileSystemId": "3b6XXX89c9", // 文件系统ID'."\n"
.' "fileSystemStorageType": "Performance", // 文件系统的存储规格'."\n"
.' "vpcId": "vpc-uf66oxxxrqge1t2gson7s" // 挂载点的VPC ID'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.' ',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'string', 'example' => 'None', 'description' => '数据集的存储导入配置信息'],
],
'MountPath' => ['title' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', 'description' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', 'type' => 'string', 'required' => false, 'example' => '/mnt/data'],
],
'required' => 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' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX'],
'Success' => ['title' => '是否创建成功', 'description' => '是否创建成功', 'type' => 'boolean', 'example' => 'true'],
'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建数据集',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31XXXX\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-dataset:3pXXXb8o0ngr07njhps1\\"\\n}","type":"json"}]',
],
'CreateDatasetVersion' => [
'summary' => '创建数据集版本，当前仅支持DataWorks数据集，支持最大版本数为20',
'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' => '数据集ID，当前仅支持DataWorks数据集', 'type' => 'string', 'required' => true, 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '数据集版本描述,长度不超过1024', 'description' => '数据集版本描述,长度不超过1024', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
[
'name' => 'Url',
'in' => 'formData',
'schema' => ['title' => 'URL地址', 'description' => 'URL地址', 'type' => 'string', 'required' => true, 'example' => 'oss://test-oss-bucket/test_dir/'],
],
[
'name' => 'MountPath',
'in' => 'formData',
'schema' => ['title' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', 'description' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', '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' => '数据集的存储导入配置, 对于不同存储类型，需要的配置信息不同'."\n"
.''."\n"
.'NAS
'."\n"
.'取值可参考文件存储 API DescribeFileSystems 的返回信息'."\n"
."\n"
.'```JSON'."\n"
.'{'."\n"
.' "fileSystemId": "3b6XXX89c9", // 文件系统ID'."\n"
.' "fileSystemStorageType": "Performance", // 文件系统的存储规格'."\n"
.' "vpcId": "vpc-uf66oxxxrqge1t2gson7s" // 挂载点的VPC ID'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.' ',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'string', 'example' => 'None', 'description' => '数据集存储导入配置'],
],
],
],
'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' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'Success' => ['title' => '是否创建成功', 'description' => '是否创建成功', 'type' => 'boolean', 'example' => 'true'],
'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'example' => 'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n"
.':2'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建数据集版本',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-datasetVersion:3pXXXb8o0ngr07njhps1\\\\n:2\\"\\n}","type":"json"}]',
],
'CreateFile' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '267402',
'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'FileFolderPath',
'in' => 'formData',
'schema' => ['description' => '文件路径。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10000'],
],
[
'name' => 'FileName',
'in' => 'formData',
'schema' => ['description' => '文件的'."\n"
.'名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'File name'],
],
[
'name' => 'FileDescription',
'in' => 'formData',
'schema' => ['description' => '文件的'."\n"
.'描述信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test'],
],
[
'name' => 'FileType',
'in' => 'formData',
'schema' => ['description' => '文件的代码类型。'."\n"
.'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n"
.'您可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '文件责任人的阿里云用户ID。如果该参数为空，'."\n"
.'则默认使用调用者的阿里云用户ID。', 'type' => 'string', 'required' => false, 'example' => '1000000000001'],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。'."\n"
.'您可以在运维中心找到对应类型的任务，右键单击查看代码，查看具体的代码格式。', 'type' => 'string', 'required' => false, 'example' => 'SHOW TABLES;'],
],
[
'name' => 'AutoRerunTimes',
'in' => 'formData',
'schema' => ['description' => '出错自动重跑的次数，'."\n"
.'取值最大为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '3'],
],
[
'name' => 'AutoRerunIntervalMillis',
'in' => 'formData',
'schema' => ['description' => '失败自动重跑时间间隔，单位为毫秒。'."\n"
.'最大为1800000毫秒（30分钟）。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>失败自动重跑”的”重跑间隔“配置对应。'."\n"
.'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120000'],
],
[
'name' => 'RerunMode',
'in' => 'formData',
'schema' => [
'description' => '重跑属性。取值如下：'."\n"
.'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n"
.'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n"
.'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n"
."\n"
.'该参数与[DataWorks控制台](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' => '是否暂停调度，取值如下：'."\n"
.'- true：暂停调度。'."\n"
.'- false：不暂停调度。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为“暂停调度”时对应。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'ParaValue',
'in' => 'formData',
'schema' => ['description' => '调度参数。多个参数之间用空格进行分割。 '."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度参数”对应。您可以参考[调度参数](~~137548~~)配置。', 'type' => 'string', 'required' => false, 'example' => 'a=x b=y'],
],
[
'name' => 'StartEffectDate',
'in' => 'formData',
'schema' => ['description' => '开始自动调度的毫秒时间戳。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '1671608450000', 'default' => '0'],
],
[
'name' => 'EndEffectDate',
'in' => 'formData',
'schema' => ['description' => '停止自动调度的时间戳，单位为毫秒。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '1671694850000'],
],
[
'name' => 'CronExpress',
'in' => 'formData',
'schema' => ['description' => '周期调度的cron表达式，该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>cron表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks会自动生成相应cron表达式。'."\n"
."\n\n"
.'示例如下：'."\n"
.'- 每天凌晨5点30分定时调度：`00 30 05 * * ?`'."\n"
."\n"
.'- 每个小时的第15分钟定时调度：`00 15 00-23/1 * * ?`'."\n"
."\n"
.'- 每隔十分钟调度一次：`00 00/10 * * * ?`'."\n"
."\n"
.'- 每天8点到17点，每隔十分钟调度一次：`00 00-59/10 8-17 * * * ?`'."\n"
."\n"
.'- 每月的1日0点20分自动调度：`00 20 00 1 * ?`'."\n"
."\n"
.'- 从1月1日0点10分开始，每过3个月调度一次：`00 10 00 1 1-12/3 ?`'."\n"
."\n"
.'- 每周二、周五的0点5分自动调度：`00 05 00 * * 2,5`'."\n"
."\n"
.'由于DataWorks调度系统的规则，cron表达式有以下限制：'."\n"
."\n"
.'- 最短调度间隔时间为5分钟。'."\n"
."\n"
.'- 每天最早调度时间为0点5分。', 'type' => 'string', 'required' => false, 'example' => '00 05 00 * * ?', 'default' => 'day'],
],
[
'name' => 'CycleType',
'in' => 'formData',
'schema' => [
'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'DAY',
'default' => 'DAY',
'enum' => ['DAY', 'NOT_DAY'],
],
],
[
'name' => 'DependentType',
'in' => 'formData',
'schema' => [
'description' => '依赖上一周期的方式。取值如下：'."\n"
."\n"
.'- SELF：依赖项选择本节点。'."\n"
.'- CHILD：依赖项选择一级子节点。'."\n"
.'- USER_DEFINE：依赖项选择其他节点。'."\n"
.'- NONE：未选择依赖项，即不会依赖上一周期。 '."\n"
.'- USER\\_DEFINE\\_AND\\_SELF： 跨周期依赖本节点和其他节点的组合的情况'."\n"
.'- CHILD\\_AND\\_SELF：跨周期依赖一层子节点和本节点的组合的情况',
'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' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“跨周期依赖（原上一周期）”后，依赖项选择“其他节点”时配置的内容对应。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'InputList',
'in' => 'formData',
'schema' => ['description' => '文件依赖的上游文件的输出名称，多个输出使用英文逗号（,）分隔。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”中配置的“上游节点输出名”对应。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'project_root,project.file1,project.001_out'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n"
."\n\n"
.'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dw_project'],
],
[
'name' => 'ResourceGroupIdentifier',
'in' => 'formData',
'schema' => ['description' => '文件发布成任务后，任务执行时对应的资源组。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，'."\n"
.'进入工作空间配置页面，在左侧导航栏单击**资源组**，获取当前工作空间已绑定资源组的ID。', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_559_1613715566828'],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['description' => '该字段已废弃，请勿使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '375827434852437'],
],
[
'name' => 'ConnectionName',
'in' => 'formData',
'schema' => ['description' => '文件发布成任务后，任务执行时连接的数据源。'."\n"
."\n"
.'您可以调用[UpdateDataSource](~~211432~~)接口获取工作空间可用的数据源列表。', 'type' => 'string', 'required' => false, 'example' => 'odps_source'],
],
[
'name' => 'AutoParsing',
'in' => 'formData',
'schema' => ['description' => '文件是否开启自动解析功能。取值如下：'."\n"
.'- true：文件会自动解析代码。'."\n"
.'- false：文件不会自动解析代码。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”的代码解析对应。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'default' => 'true'],
],
[
'name' => 'SchedulerType',
'in' => 'formData',
'schema' => [
'description' => '调度的类型，取值如下：'."\n"
."\n"
.'- NORMAL：正常调度任务。'."\n"
.'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n"
.'- PAUSE：暂停任务。'."\n"
.'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [],
'example' => 'NORMAL',
'enum' => ['NORMAL', 'MANUAL', 'PAUSE', 'SKIP'],
],
],
[
'name' => 'AdvancedSettings',
'in' => 'formData',
'schema' => ['description' => '任务的高级配置。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“高级设置”对应。'."\n"
."\n"
.'当前仅EMR Spark Streaming和EMR Streaming SQL任务支持配置该参数，并且参数为JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}'],
],
[
'name' => 'StartImmediately',
'in' => 'formData',
'schema' => ['description' => '发布后是否立即启动。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式”对应。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'default' => 'false'],
],
[
'name' => 'InputParameters',
'in' => 'formData',
'schema' => ['description' => '节点的上下文输入参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的InputContextParameterList参数结构。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输入参数”对应。', 'type' => 'string', 'required' => false, 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]'],
],
[
'name' => 'OutputParameters',
'in' => 'formData',
'schema' => ['description' => '节点的上下文输出参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的OutputContextParameterList参数结构。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输出参数”对应。', 'type' => 'string', 'required' => false, 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]'],
],
[
'name' => 'IgnoreParentSkipRunningProperty',
'in' => 'formData',
'schema' => ['description' => '是否沿用上一周期空跑属性。取值如下：'."\n"
."\n\n"
.'- true：沿用上一周期空跑属性。'."\n"
."\n"
.'- false：不沿用上一周期空跑属性。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'CreateFolderIfNotExists',
'in' => 'formData',
'schema' => ['description' => '当参数中指定的目录（FileFolderPath）在系统中不存在时，是否自动创建此目录。取值如下：'."\n"
."\n\n"
.'- true：若此目录不存在，自动创建此目录'."\n"
.'- false：若此目录不存在，调用失败', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ApplyScheduleImmediately',
'in' => 'formData',
'schema' => ['description' => '是否发布后立即生效调度配置。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Timeout',
'in' => 'formData',
'schema' => ['description' => '调度配置超时定义。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'ImageId',
'in' => 'formData',
'schema' => ['description' => '自定义镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-bp1h4b5a8ogkbll2f3tr'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => ['description' => '文件创建成功后的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001'],
'RequestId' => ['description' => '本次调用的唯一ID。'."\n"
.'出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG'],
'ErrorMessage' => ['description' => '错误消息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码'."\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.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]',
'title' => '在数据开发中创建一个文件',
'summary' => '调用CreateFile，在数据开发中创建一个文件。目前不支持调用该接口创建数据集成节点任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与**ProjectIdentifier**参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与**ProjectId**参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FolderPath',
'in' => 'formData',
'schema' => ['description' => '文件夹的路径'."\n"
.'。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/System_Data/MaxCompute/import_layer'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => ['description' => '新建文件夹的唯一标识符'."\n"
.'。', 'type' => 'string', 'example' => 'bdfd68****'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'Success' => ['description' => '调用是否成功。'."\n"
.'取值如下：'."\n"
."\n"
.'true：调用成功'."\n"
."\n"
.'false：调用失败', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码'."\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.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"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' => '创建文件夹',
'summary' => '调用CreateFolder创建文件夹。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateFunction' => [
'summary' => '调用此接口，可以在数据开发中创建一个udf函数。udf函数信息以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' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "Function",'."\n"
.' "spec": {'."\n"
.' "functions": ['."\n"
.' {'."\n"
.' "name": "function name",'."\n"
.' "script": {'."\n"
.' "content": "{\\"name\\": \\"function name\\", \\"datasource\\": {\\"type\\": \\"ODPS\\", \\"name\\": \\"ODPS_first\\"}, \\"runtimeResource\\": {\\"resourceGroup\\": \\"s_res_group_xx_xxxx\\"}}",'."\n"
.' "path": "XXX/OpenAPI/function/function name",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_FUNCTION"'."\n"
.' }'."\n"
.' },'."\n"
.' "datasource": {'."\n"
.' "name": "ODPS_first",'."\n"
.' "type": "ODPS"'."\n"
.' },'."\n"
.' "runtimeResource": {'."\n"
.' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7****'],
'Id' => ['description' => 'UDF函数的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'example' => '580667964888595XXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7****\\",\\n \\"Id\\": \\"580667964888595XXXX\\"\\n}","type":"json"}]',
'title' => '创建数据开发函数',
'description' => '>该接口不支持批量操作，若FlowSpec中定义了不止一个udf函数，则除第一个以外的后续函数均会被忽略。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateIdentifyCredential' => [
'summary' => '创建身份凭证。',
'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' => '用户身份凭证对象',
'required' => false,
'enumValueTitles' => [],
'$ref' => '#/components/schemas/IdentifyCredential',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'Data' => ['description' => 'success true or false', 'type' => 'string', 'example' => '{ "HttpStatusCode": 200, "Success": true }'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建身份凭证',
'description' => '>该接口目前不支持批量操作，参数中填写多个发布实体时，除第一个以外的部分会被直接忽略。>',
'requestParamsDescription' => '注意：'."\n"
.'UserType、DataSource.Type、DataSource.Role 都必须传枚举范围内的值',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\"\\n}","type":"json"}]',
],
'CreateLineageRelationship' => [
'summary' => '注册数据地图的血缘关系。通过此接口，可以在 DataWorks 纳管元数据实体之间建立血缘关系，包括表与表、字段与字段、表与字段、数据集与表等场景；也可以在纳管实体与用户自行注册的自定义实体对象之间建立血缘关系。接口兼容非纳管自定义对象，但该方式已不再推荐。调用前需确保参与血缘注册的纳管实体已存在于 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' => '源实体'."\n"
.'。', 'required' => false, '$ref' => '#/components/schemas/LineageEntity'],
],
[
'name' => 'DstEntity',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => '目标实体'."\n"
.'。', 'required' => false, '$ref' => '#/components/schemas/LineageEntity'],
],
[
'name' => 'Task',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => '任务信息'."\n"
.'。', 'required' => false, '$ref' => '#/components/schemas/LineageTask'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID，'."\n"
.'一次请求的唯一标识。', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Id' => ['description' => '血缘关系ID。', 'type' => 'string', 'example' => '4as3dasf654a'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]',
'title' => '注册数据地图血缘关系',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'requestParamsDescription' => '## 实体对象 (SrcEntity / DstEntity)'."\n"
."\n"
.'用于描述血缘关系的源端和目标端，支持在以下类型的实体之间注册血缘关系：'."\n"
."\n"
.'| 实体类型 | 是否需要提前注册实体 | Id 获取方式 | 说明 |'."\n"
.'| --- | --- | --- | --- |'."\n"
.'| DataWorks 已采集表 | 否 | 调用 `ListTables` 或 `GetTable`，使用返回结果中的 `Id` | 适用于 DataWorks 平台已采集到的表或用户自己注册的扩展表。 |'."\n"
.'| DataWorks 已采集字段 | 否 | 调用 `ListColumns` 或 `GetColumn`，使用返回结果中的 `Id` | 已采集表对应的字段。 |'."\n"
.'| 数据集 | 否，若数据集已存在；创建新数据集时需先调用 `CreateDataset` | 调用 `CreateDataset`、`ListDatasets` 或 `GetDataset`，使用返回结果中的 `Id` | 适用于 DataWorks 数据集实体。 |'."\n"
.'| 数据集版本 | 否，若版本已存在；创建新版本时需先调用 `CreateDatasetVersion` | 调用 `CreateDatasetVersion`、`ListDatasetVersions` 或 `GetDatasetVersion`，使用返回结果中的 `Id` | 适用于数据集的具体版本。 |'."\n"
.'| 用户注册的自定义实体对象 | 是 | 先调用 `CreateMetaEntityDef` 创建自定义实体定义，再调用 `BatchCreateMetaEntities` 创建实体对象，使用返回结果中的 `Id` | 适用于需要在 DataWorks 中纳管和查询的自定义实体。 |'."\n"
.'| 非纳管自定义对象（不推荐） | 否 | 调用方自行指定以 `custom-` 开头的 `Id`，格式为 `custom-{Type}:{Identifier}` | 兼容历史用法，目前已不再推荐。对于外部报表、第三方系统对象等自定义对象，更建议先注册为 DataWorks 自定义实体对象后再注册血缘。 |'."\n"
."\n"
.'补充说明：'."\n"
."\n"
.'- 对于 DataWorks 已采集到的表、字段、数据集、数据集版本，建议不要手动拼接 `Id`，应优先使用对应 `Get` 或 `List` API 返回的 `Id`。'."\n"
.'- 对于自定义对象，推荐使用用户注册的自定义实体对象方式，需要先完成实体定义和实体对象注册：'."\n"
.' 1. 调用 `CreateMetaEntityDef` 创建自定义实体定义。'."\n"
.' 2. 调用 `BatchCreateMetaEntities` 创建具体实体对象。'."\n"
.' 3. 使用 `BatchCreateMetaEntities` 返回的实体 `Id` 作为 `SrcEntity.Id` 或 `DstEntity.Id`。'."\n"
.'- 对于非纳管自定义对象，不需要调用 `CreateMetaEntityDef` 或 `BatchCreateMetaEntities`。只需传入以 `custom-` 开头的实体 `Id`，并填写 `Name`。该方式主要用于兼容历史场景，目前已不再推荐；新接入场景建议使用注册自定义实体对象的方式，便于后续查询、管理和扩展自定义属性。'."\n"
.'- `SrcEntity.Attributes` 和 `DstEntity.Attributes` 表示实体端点的扩展属性；血缘关系本身的属性请放在 `Task.Attributes` 中。'."\n"
."\n"
.'## 任务信息 (Task)'."\n"
."\n"
.'用于描述产生该血缘关系的作业或任务信息。'."\n"
."\n"
.'| 参数名称 | 类型 | 是否必选 | 描述 |'."\n"
.'| --- | --- | --- | --- |'."\n"
.'| Id | String | 否 | 任务唯一标识。建议必传稳定值，便于幂等注册、查询和删除。仅支持字母、数字、下划线，长度不超过 64。 |'."\n"
.'| Type | String | 是 | 任务类型。必须以 `custom-` 开头，仅支持字母、数字、下划线、连字符，长度不超过 64。 |'."\n"
.'| Attributes | Map | 否 | 任务属性，最多支持 20 个属性，复杂值需序列化为 JSON 字符串。
• Key: 属性名（字母/数字/下划线，≤64字符）
• Value: 属性值（≤128字符）。 |'."\n"
."\n"
.'## 请求示例'."\n"
."\n"
.'### DataWorks 已采集表与自定义实体对象'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "SrcEntity": {'."\n"
.' "Id": "custom_entity-customer_api:api_001",'."\n"
.' "Name": "api_001"'."\n"
.' },'."\n"
.' "DstEntity": {'."\n"
.' "Id": "mysql-table:rm-xxx::demo_db::demo_table",'."\n"
.' "Name": "demo_table"'."\n"
.' },'."\n"
.' "Task": {'."\n"
.' "Id": "api_to_table_001",'."\n"
.' "Type": "custom-lineage-task",'."\n"
.' "Attributes": {'."\n"
.' "scene": "api_to_table",'."\n"
.' "owner": "zhangsan"'."\n"
.' }'."\n"
.' }'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 非纳管自定义对象与 DataWorks 已采集表'."\n"
."\n"
.'> 该方式主要用于兼容历史用法，目前已不再推荐。新接入场景建议先通过 `CreateMetaEntityDef` 和 `BatchCreateMetaEntities` 注册自定义实体对象，再使用返回的实体 `Id` 注册血缘。'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "SrcEntity": {'."\n"
.' "Id": "custom-report:report_001",'."\n"
.' "Name": "report_001"'."\n"
.' },'."\n"
.' "DstEntity": {'."\n"
.' "Id": "maxcompute-table:::demo_project:default:demo_table",'."\n"
.' "Name": "demo_table"'."\n"
.' },'."\n"
.' "Task": {'."\n"
.' "Id": "report_to_table_001",'."\n"
.' "Type": "custom-lineage-task",'."\n"
.' "Attributes": {'."\n"
.' "scene": "report_to_table"'."\n"
.' }'."\n"
.' }'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateMcpServer' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => 'MCP Server 名称，租户级唯一；以小写字母开头，仅允许 `a-z` / `0-9` / `_` / `-`'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server'],
],
[
'name' => 'Config',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'MCP Server 连接配置'."\n",
'type' => 'object',
'properties' => [
'Url' => ['description' => 'MCP Server 服务地址，必须以 `https://` 开头'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://example.com/mcp/sse'],
'Transport' => [
'description' => '传输协议'."\n",
'type' => 'string',
'required' => false,
'example' => 'SSE',
'enum' => ['STREAMABLE_HTTP', 'SSE'],
],
'CustomHeaders' => ['description' => '自定义请求头（键值对）；保留头不允许覆盖'."\n", 'type' => 'object', 'required' => false, 'example' => '{}'],
],
'required' => false,
'example' => '-',
],
],
[
'name' => 'Visibility',
'in' => 'formData',
'schema' => [
'description' => '可见性级别'."\n",
'type' => 'string',
'required' => false,
'example' => 'TENANT',
'enum' => ['TENANT', 'PROJECT', 'USER'],
],
],
[
'name' => 'VisibilityScope',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '可见性范围，按 Visibility 取对应字段。'."\n",
'type' => 'object',
'properties' => [
'ProjectIds' => [
'description' => '可见的项目 ID 列表，Visibility 为 `PROJECT` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '返回的DataWorks工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
'required' => false,
],
'UserIds' => [
'description' => '可见的用户 ID 列表，Visibility 为 `USER` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '用户ID', 'type' => 'string', 'required' => false, 'example' => '123456'],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '创建成功的 MCP Server。'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request（请求 ID）'."\n", 'type' => 'string', 'example' => 'valueA'],
'McpServer' => [
'description' => '登记的 MCP Server'."\n",
'type' => 'object',
'properties' => [
'Name' => ['description' => 'MCP Server 名称'."\n", 'type' => 'string', 'example' => 'my-mcp-server'],
'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建MCP Server',
'summary' => '创建 MCP Server',
'description' => '## 请求说明'."\n"
.'- 提交后系统会根据填写的连接信息校验MCP Server的可用性。'."\n"
.'- 如果MCP Server连接不可用，接口将返回相应的错误信息。'."\n"
.'- `Name`字段需以小写字母开头，仅支持小写字母、数字、下划线（_）和短横线（-），且在当前账号下唯一。'."\n"
.'- `Visibility`字段定义了MCP Server的可见性级别，可选值为`TENANT`（账号内可见）、`PROJECT`（指定项目可见）、`USER`（指定用户可见）。根据选择的不同，需要提供对应的`VisibilityScope`参数来进一步指定可见范围。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"valueA\\",\\n \\"McpServer\\": {\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]',
],
'CreateMetaCollection' => [
'summary' => '创建数据地图集合对象，支持创建数据地图类目（包括多级子类目）、数据专辑（专辑子类目）两种类型的集合对象。',
'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' => '父节点集合对象Id。', 'type' => 'string', 'required' => false, 'example' => 'as78d756asd'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '集合对象名称。', 'type' => 'string', 'required' => true, 'example' => 'test_album'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '集合类型，可枚举，取值为'."\n"
."\n"
.' - Category 类目'."\n"
.' - Album 数据专辑'."\n"
.' - AlbumCategory 专辑子类目',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Category',
'enum' => ['Category', 'Album', 'AlbumCategory'],
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '集合对象描述。', 'type' => 'string', 'required' => false, 'example' => 'test comment'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'],
'Id' => ['description' => '创建成功后集合对象的ID。', 'type' => 'string', 'example' => '4as3dasf654a'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]',
'title' => '创建数据地图集合对象',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateMetaEntityDef' => [
'summary' => '创建元数据实体定义（包括纯自定义类型和扩展表类型）。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '类型定义名称。纯自定义类型需匹配 `^[a-z0-9][a-z0-9_]*$`；扩展表类型需匹配 `^[a-z0-9][a-z0-9_]*-table$`', 'description' => '类型定义名称。纯自定义类型需匹配 `^[a-z0-9][a-z0-9_]*$`；扩展表类型需匹配 `^[a-z0-9][a-z0-9_]*-table$`', 'type' => 'string', 'required' => true, 'example' => 'biz_api'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['title' => '展示名称，最长32个字符', 'description' => '展示名称，最长32个字符', 'type' => 'string', 'required' => true, 'example' => 'Business API'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
[
'name' => 'Extend',
'in' => 'formData',
'schema' => [
'title' => '扩展模式。NONE或不填表示纯自定义实体；TABLE表示扩展表类型',
'description' => '扩展模式。'."\n"
.'- NONE，默认值，表示纯自定义实体，属性自由定义；'."\n"
.'- TABLE表示扩展表类型，参考数据地图已有表类型的方式介入，不需要提供属性定义，可以创建对应的Database/Table对象',
'type' => 'string',
'required' => false,
'example' => 'NONE',
'enum' => ['NONE', 'TABLE'],
],
],
[
'name' => 'AttributeDefs',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '纯自定义实体的属性定义列表。extend=TABLE时不能传入',
'description' => '纯自定义实体的属性定义列表。extend=TABLE时不能传入',
'type' => 'array',
'items' => ['description' => '属性定义', 'required' => false, '$ref' => '#/components/schemas/MetaEntityAttributeDef'],
'required' => false,
'example' => '[]',
'maxItems' => 100,
],
],
],
'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' => '0A04C673-BEFA-5803-94E5-89E2D9F8C567'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'EntityType' => ['title' => '创建后的实体类型', 'description' => '创建后的实体类型', 'type' => 'string', 'example' => 'custom_entity-biz_api'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建元数据实体类型定义',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A04C673-BEFA-5803-94E5-89E2D9F8C567\\",\\n \\"Success\\": true,\\n \\"EntityType\\": \\"custom_entity-biz_api\\"\\n}","type":"json"}]',
],
'CreateNetwork' => [
'summary' => '创建并绑定通用资源组网络资源。',
'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' => '所属通用资源组的唯一标识。', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003****'],
],
[
'name' => 'VpcId',
'in' => 'formData',
'schema' => ['title' => '网络资源的VPC ID', 'description' => '网络资源的VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-m2et4f3oc8msfbccXXXXX'],
],
[
'name' => 'VswitchId',
'in' => 'formData',
'schema' => ['title' => '网络资源的交换机ID', 'description' => '网络资源的交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX'],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['title' => '客户端幂等性标识，用于保证创建网络资源操作的幂等性', 'description' => '客户端幂等性标识，用于保证创建网络资源操作的幂等性。', 'type' => 'string', 'required' => true, 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'Id' => ['title' => '创建的网络资源ID', 'description' => '创建的网络资源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', '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' => '创建资源组网络',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateNode' => [
'summary' => '调用该接口，会在新版数据开发中创建一个数据开发节点。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
'name' => 'ContainerId',
'in' => 'formData',
'schema' => ['description' => '当你需要将节点创建在一个容器内部时，你需要指定这个参数。该参数为一个容器的唯一标识，这个容器可以是一个Workflow或者一个容器节点。'."\n"
."\n"
.'>该参数填写后，FlowSpec中定义的path字段将无效>'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => false, 'example' => '23451286945488XXXX'."\n"],
],
[
'name' => 'Scene',
'in' => 'formData',
'schema' => [
'description' => '节点创建的场景，决定节点创建在手动节点区域还是数据开发区域。DataworksManualWorkflow只在填写了ContainerId且Container为手动工作流时才能使用。'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- DATAWORKS_PROJECT 项目目录'."\n"
.'- DATAWORKS_MANUAL_WORKFLOW 手动工作流'."\n"
.'- DATAWORKS_MANUAL_TASK 手动任务',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'DATAWORKS_PROJECT',
],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个节点的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n"
."\n"
.'> 如何快速获取FlowSpec模板？'."\n"
.'> - 在数据开发中打开节点->点击右侧版本->查看最新版本->查看调度配置，即可得到针对当前节点的FlowSpec描述。可以基于版本中的FlowSpec描述快速构建符合要求的模板。'."\n"
."\n"
.'> 节点的内容如何填写？'."\n"
.'> - 节点的内容填写到$.spec.nodes[*].script.content字段中。'."\n"
."\n"
.'> 离线同步节点的内容如何配置？'."\n"
.'> - 需要参考[通过脚本模式配置离线同步任务](https://help.aliyun.com/zh/dataworks/user-guide/configure-a-batch-synchronization-node-by-using-the-code-editor)中的步骤四编写脚本，并将内容填写到$.spec.nodes[*].script.content字段中。或者在页面上创建一个离线同步节点，通过查看版本的方式获取离线同步节点的脚本内容。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "Node",'."\n"
.' "spec": {'."\n"
.' "nodes": ['."\n"
.' {'."\n"
.' "recurrence": "Normal",'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "datasource": {'."\n"
.' "name": "odps_test"'."\n"
.' },'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPI_Test/odpsSQL_Test",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_SQL"'."\n"
.' },'."\n"
.' "content": "select now();"'."\n"
.' },'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "cron": "00 00 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "runtimeResource": {'."\n"
.' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n"
.' },'."\n"
.' "name": "odpsSQL_Test",'."\n"
.' "inputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "project_root",'."\n"
.' "artifactType": "NodeOutput"'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "output_data",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "odpsSQL_Test"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'],
'Id' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'example' => '860438872620113XXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n}","type":"json"}]',
'title' => '创建数据开发节点',
'description' => '>该接口不支持批量操作，若FlowSpec中定义了不止一个节点，则除第一个以外的后续节点均会被忽略。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:48:25.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateParameter' => [
'summary' => '创建一个参数。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '参数名称，工作空间下唯一。需要"workspace."开头。后续内容以字母开头，且只能包含字母下划线和数字，Name总长度不超过255。', 'type' => 'string', 'required' => true, 'example' => 'workspace.para'],
],
[
'name' => 'Properties',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '参数值配置，生产环境必填。如果数组中出现了重复的环境配置，则后出现的配置不生效。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EnvType' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'example' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
'Value' => ['description' => '参数值。只允许汉字、字母、数字和部分特殊字符，如/、:、.、[、]、,、\\\\、\\\'、"、_、=、?、空格、回车、换行、+、-、*、%、&、@、!、$、#、{、}', 'type' => 'string', 'required' => false, 'example' => 'value123'],
],
'required' => false,
'description' => '',
],
'required' => true,
],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '类型。'."\n"
.'- PlainConstant 常量（明文）'."\n"
.'- SecretConstant 常量（密文）'."\n"
.'- Variable 变量',
'type' => 'string',
'required' => true,
'example' => 'PlainConstant',
'enum' => ['PlainConstant', 'SecretConstant', 'Variable'],
],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '工作空间Id（Scope=Project时必填）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '责任人的账号 ID。', 'type' => 'string', 'required' => true, 'example' => '123456789'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a test parameter.'],
],
[
'name' => 'Scope',
'in' => 'formData',
'schema' => [
'description' => '参数使用范围。默认Project，暂不可选择其他类型。',
'type' => 'string',
'required' => false,
'example' => 'Project',
'default' => 'Project',
'enum' => ['Project'],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Id' => ['description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建参数',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 123,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'CreatePipelineRun' => [
'summary' => '调用此接口，可以对新版数据开发中的实体创建一个发布流程。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '267910',
'abilityTreeNodes' => ['FEATUREdide4AR6E0'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['title' => '项目Id', 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'pattern' => '', 'default' => ''],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => '表示发布流程是上线还是下线'."\n"
."\n"
.'- Online：上线'."\n"
."\n"
.'- Offline：下线', 'type' => 'string', 'required' => true, 'example' => 'Online'],
],
[
'name' => 'ObjectIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '本次发布流程希望发布的实体Id列表。'."\n"
.'>目前只支持对于单个实体及其子实体的发布，因此只有该array的第一个实体及其子实体会被发布成功。请确保该array的长度为1，超出1的部分会被忽略。>',
'type' => 'array',
'items' => ['description' => '希望发布的实体Id，如Node、WorkflowDefinition等实体的Id。'."\n"
.'>WorkflowDefinition只允许作为整体发布，目前不支持单独发布Workflow内部的单个节点>', 'type' => 'string', 'required' => false, 'example' => '476506242076571XXXX'],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '对于发布流程的描述信息', 'type' => 'string', 'required' => false, 'example' => 'This is a OdpsSQL-node publishing process. The function is XXXX.'],
],
[
'name' => 'RunMode',
'in' => 'formData',
'schema' => [
'description' => '发布流程的运行模式，默认为Normal。当填写Auto时，会自动驱动该发布流程跑到指定阶段，需要配合AutoRunUntilStage字段使用。'."\n"
."\n"
.'可选值：'."\n"
.'- Normal'."\n"
.'- Auto',
'type' => 'string',
'required' => false,
'example' => 'Normal',
'enum' => ['Normal', 'Auto'],
],
],
[
'name' => 'AutoRunUntilStage',
'in' => 'formData',
'schema' => ['description' => '需要填写发布流程Stage对应的Code。当RunMode为Auto时生效，该发布流程会在创建后自动运行到指定阶段。'."\n"
."\n"
.'>指定阶段会被自动运行完。例如填写DEV时，自动运行会在DEV阶段到达终态后停止。>', 'type' => 'string', 'required' => false, 'example' => 'DEV'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。'."\n", 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'],
'Id' => ['description' => '发布流程的唯一标识符', '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' => '创建发布流程',
'description' => '>该接口目前不支持批量操作，参数中填写多个发布实体时，除第一个以外的部分会被直接忽略。>'."\n"
.'>低版本的SDK中可能无该接口，此时请使用CreateDeployment接口，参数与该文档一致。>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateProcessDefinition' => [
'summary' => '用于创建新的审批流程定义，支持自定义配置审批规则和通知服务。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '243667',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '流程定义名称'."\n", 'type' => 'string', 'required' => true, 'example' => '我的审批策略'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '流程定义描述'."\n", 'type' => 'string', 'required' => true, 'example' => '这是一个示例策略'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => '流程定义类型，枚举：'."\n"
."\n"
.'1. MaxCompute'."\n"
.'2. DataService'."\n"
.'3. Extension'."\n"
.'4. Hologres', 'type' => 'string', 'required' => false, 'example' => 'Extension', 'default' => 'MaxCompute'],
],
[
'name' => 'SubType',
'in' => 'formData',
'schema' => ['description' => '子类型，枚举：'."\n"
."\n"
.'- Table'."\n"
.'- Column'."\n"
.'- Database'."\n"
.'- Schema'."\n"
.'- Default', 'type' => 'string', 'required' => false, 'example' => 'Table', 'default' => 'Table'],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '是否启用'."\n", 'type' => 'boolean', 'required' => false, 'default' => 'true'],
],
[
'name' => 'RuleConditions',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '条件规则列表'."\n",
'type' => 'array',
'items' => [
'description' => '规则',
'type' => 'object',
'properties' => [
'Type' => ['description' => '条件类型，枚举：'."\n"
."\n"
.'- `odpsProject`, '."\n"
.'- `hologresInstanceId`'."\n"
.'- `sensibleLevel`, '."\n"
.'- `tableGuid`, '."\n"
.'- `projectId`', 'type' => 'string', 'required' => false, 'example' => 'odpsProject'],
'Scope' => ['description' => '规则生效阶段：'."\n"
.'- `Deployment` 用于判定"提交申请时是否匹配该审批策略'."\n"
.'- `Running` 用于审批流程执行判定是否免审批【仅支持MaxCompute类型】', 'type' => 'string', 'required' => false, 'example' => 'Deployment'],
'Expression' => ['description' => '条件表达式((#type==\'typeValue\')).如 ((#odpsProject==\'PX_BEIJING_TEST\'))', 'type' => 'string', 'required' => false, 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))'],
],
'required' => false,
],
'required' => true,
'minItems' => 1,
],
],
[
'name' => 'NotificationServices',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '通知服务声明',
'type' => 'array',
'items' => [
'description' => '通知服务声明',
'type' => 'object',
'properties' => [
'Channel' => ['description' => '通知渠道，枚举'."\n"
."\n"
.'- Mail'."\n"
.'- Sms'."\n"
.'- DingRobot'."\n"
.'- Weixin', 'type' => 'string', 'required' => false, 'example' => 'DingRobot'],
'Extension' => ['description' => '扩展信息，JSON 格式，如 `{"atAll":"true"}` 声明是否@所有人'."\n", 'type' => 'string', 'required' => false, 'example' => '{"atAll":"true"}'],
'Receiver' => ['description' => 'Channel 为DingRobot/Weixin时需指定 WebhookUrl'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://dingtalk.com'],
],
'required' => false,
],
'required' => false,
'minItems' => 1,
],
],
[
'name' => 'ApprovalNodes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '审批节点列表'."\n",
'type' => 'array',
'items' => [
'description' => '节点',
'type' => 'object',
'properties' => [
'Name' => ['description' => '节点名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'default-name'],
'AccountType' => ['description' => '节点审批人类型：'."\n"
.'- DataWorksProjectRole 空间角色'."\n"
.'- DataWorksProjectMember 空间成员'."\n"
.'- TableAdministrator 表负责人'."\n"
.'- TableOrProjectAdministrator 表或空间管理员'."\n"
.'- AliyunResourceOwner 阿里云账号'."\n"
.'- MaxComputeRole MC管理员'."\n"
.'- DLFAdmin DlfLegacy管理员'."\n"
.'- DLFNextAdmin DLFNext管理员'."\n"
.'- TenantRole 租户角色'."\n"
.'- EmrAdministrator Emr管理员'."\n"
.'- LindormAdministrator Lindorm管理员'."\n"
.'- AliyunRamUser RAM子账号'."\n", 'type' => 'string', 'required' => false, 'example' => 'TableOrProjectAdministrator'],
'Assignees' => [
'description' => '当 `AccountType` 为不同类型，对应不同语义：'."\n"
.'- DataWorksProjectMember 声明空间成员 UserId'."\n"
.'- DataWorksProjectRole 声明空间角色 code'."\n"
.' - 若需工作空间自定义角色，需声明为“custom-role”，并在ExtensionProperties进一步配置'."\n"
.'- MaxComputeRole 声明 MC 的角色'."\n"
.'- TenantRole 声明租户角色 code'."\n"
.'- AliyunRamUser 声明 RAM userId',
'type' => 'array',
'items' => ['description' => '审批人', 'type' => 'string', 'required' => false, 'example' => '213463068144525171'],
'required' => false,
],
'ExtensionProperties' => [
'description' => '当 `AccountType ` 为不同类型，需要提供不同额外声明：'."\n"
."\n"
.'- DataWorksProjectMember，需设置不同空间成员UserId：'."\n"
.' - key 为 工作空间Id, value 为空间成员 UserId，多个使用逗号分割'."\n"
."\n"
.'- DataWorksProjectRole，需设置不同空间自定义角色Code：'."\n"
.' - key 为 工作空间Id, value 为空间自定义角色 Code，多个使用逗号分割'."\n"
."\n"
.'- MaxComputeRole，需设置MaxCompute Project项目下角色：'."\n"
.' - key 为 MaxCompute 的 project, value 为 MC 中 role name，多个使用逗号分割',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "449656": "role_project_admin,role_project_pe"'."\n"
.' }', 'description' => '扩展说明'],
],
],
'required' => false,
],
'required' => true,
'minItems' => 1,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等串，建议使用UUID。', 'type' => 'string', 'required' => false, 'example' => '0000-ABCD-EFG****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '**API请求ID**'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
'Id' => ['description' => '流程定义 ID', 'type' => 'string', 'example' => '1010543619'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建审批流程定义',
'description' => '## 请求说明'."\n"
.'- 该API允许用户创建一个新的审批流程定义，包括设置审批策略名称、描述、类型、子类型等基本信息。'."\n"
.'- 用户可以定义条件规则列表（RuleConditions），指定在何种条件下触发审批流程。'."\n"
.'- 支持配置多种通知服务（NotificationServices），以便在审批流程的不同阶段向相关人员发送通知。'."\n"
.'- 审批节点列表（ApprovalNodes）定义了审批过程中需要经过的各个节点及其审批人信息。'."\n"
.'- 可以选择是否立即启用新创建的审批流程定义。'."\n"
.'- 注意：部分字段如Type有特定值限制，请参考文档中的约束描述部分。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"Id\\": \\"1010543619\\"\\n}","type":"json"}]',
],
'CreateProject' => [
'summary' => '创建工作空间。',
'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' => '工作空间名称。'."\n"
."\n"
.'约束说明：'."\n"
."\n"
.'- 工作空间名称要求Region下唯一。'."\n"
."\n"
.'- 需要字母开头，只能包含字母、数字和下划线（_）'."\n"
."\n"
.'- 限制3~28个字符。', 'type' => 'string', 'required' => true, 'example' => 'sora_finance'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => '工作空间展示名称。', 'type' => 'string', 'required' => true, 'example' => 'Sora financial analysis'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '工作空间描述。', 'type' => 'string', 'required' => false, 'example' => 'Financial analysis group project data development'],
],
[
'name' => 'AliyunResourceGroupId',
'in' => 'formData',
'schema' => ['description' => '工作空间所属阿里云资源组ID。您可以登录[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups)，进入资源组列表页面获取 ID。'."\n"
."\n"
.'该参数用来将本次创建的DataWorks工作空间纳入选定的阿里云资源组管理。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzbn7****'],
],
[
'name' => 'PaiTaskEnabled',
'in' => 'formData',
'schema' => ['description' => '是否启用PAI任务调度：'."\n"
."\n"
.'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n"
."\n"
.'- false 禁用PAI任务调度。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DevEnvironmentEnabled',
'in' => 'formData',
'schema' => ['description' => '是否启用开发环境：'."\n"
."\n"
.'- true'."\n"
.'工作空间启用开发环境，支持开发与生产环境隔离。'."\n"
."\n"
.'- false 仅使用生产环境。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'AliyunResourceTags',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'batch'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'blue'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'DevRoleDisabled',
'in' => 'formData',
'schema' => ['description' => '是否禁用开发角色：'."\n"
."\n"
.'- false，开启开发角色（默认）'."\n"
."\n"
.'- true，禁用开发角色', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n"],
'ProjectId' => ['title' => '该字段即将废弃，请使用Id字段。', 'description' => '本次创建的 DataWorks 工作空间的 ID。'."\n"
.'注意：该字段已废弃，将使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '123456'],
'Id' => ['description' => '本次创建的 DataWorks 工作空间的 ID。', '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' => '新建工作空间',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateProjectMember' => [
'summary' => '添加工作空间成员同时授予工作空间角色。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '24054'],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'Dataworks账号 ID 。您可以登录[ DataWorks 控制台—管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要添加成员的工作空间进入管理中心页面，进入 **租户成员与角色** 页面，查看需要加入工作空间的账号 ID。', 'type' => 'string', 'required' => true, 'example' => '123422344899'],
],
[
'name' => 'RoleCodes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作空间角色 Code 列表。 您可以调用[ListProjectRoles](~~2853930~~) 获取角色的 Code。'."\n"
."\n"
.'该参数用来添加空间成员时同步授予其工作空间角色 。',
'type' => 'array',
'items' => ['description' => '工作空间角色 Code 。', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest'],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', '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' => '创建工作空间成员',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateProjectMember',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateProjectRole' => [
'summary' => '新建工作空间自定义角色',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244504',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n"
."\n"
.'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '角色名称', 'type' => 'string', 'required' => true, 'example' => 'category_role', 'maxLength' => 30],
],
[
'name' => 'ModulePermissions',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Dataworks模块权限列表',
'type' => 'array',
'items' => [
'description' => 'Dataworks模块权限',
'type' => 'object',
'properties' => [
'ModuleId' => [
'title' => '2: HoloStudio'."\n"
.'3: StreamStudio'."\n"
.'4: 发布管理'."\n"
.'6: 数据保护伞'."\n"
.'7: 数据地图'."\n"
.'8: 数据服务'."\n"
.'9: 数据集成'."\n"
.'10: 数据建模（DataBlau DDM）'."\n"
.'11: 数据开发'."\n"
.'12: 数据质量'."\n"
.'13: 数据综合治理'."\n"
.'14: 运维中心'."\n"
.'15: 资源优化'."\n"
.'16: 迁移助手'."\n"
.'17: 数据分析'."\n"
.'18: 审批中心'."\n"
.'19: 安全中心'."\n"
.'20: 智能数据建模'."\n",
'description' => 'Dataworks模块ID如下：'."\n"
.'- 2: HoloStudio'."\n"
.'- 3: StreamStudio'."\n"
.'- 4: 发布管理'."\n"
.'- 6: 数据保护伞'."\n"
.'- 7: 数据地图'."\n"
.'- 8: 数据服务'."\n"
.'- 9: 数据集成'."\n"
.'- 10: 数据建模（DataBlau DDM）'."\n"
.'- 11: 数据开发'."\n"
.'- 12: 数据质量'."\n"
.'- 13: 数据综合治理'."\n"
.'- 14: 运维中心'."\n"
.'- 15: 资源优化'."\n"
.'- 16: 迁移助手'."\n"
.'- 17: 数据分析'."\n"
.'- 18: 审批中心'."\n"
.'- 19: 安全中心'."\n"
.'- 20: 智能数据建模',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [2 => 'HoloStudio', 'StreamStudio', '发布管理', 6 => '数据保护伞', '数据地图', '数据服务', '数据集成', '数据建模（DataBlau DDM）', '数据开发', '数据质量', '数据综合治理', '运维中心', '资源优化', '迁移助手', '数据分析', '审批中心', '安全中心', '智能数据建模'],
'example' => '2',
],
'PermissionType' => [
'description' => '权限类型。取值如下：'."\n"
.'- Write：只读'."\n"
.'- Read：编辑'."\n"
.'- NotSet：未控制',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Write' => 'Write', 'Read' => 'Read'],
'example' => 'Write',
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '客户端Token', 'type' => 'string', 'required' => false, 'example' => '保留字段'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => 'B313938A-4475-599B-98EB-A0875019FD5B'],
'Code' => ['description' => '角色唯一标识', 'type' => 'string', 'example' => 'base_role_dte'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '新建工作空间自定义角色',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B313938A-4475-599B-98EB-A0875019FD5B\\",\\n \\"Code\\": \\"base_role_dte\\"\\n}","type":"json"}]',
],
'CreateResource' => [
'summary' => '调用此接口，可以在数据开发中创建一个数据开发文件资源，文件资源的信息定义以FlowSpec格式描述。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'pattern' => '', 'default' => ''],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个资源文件的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "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' => '资源包含的具体的文件流或OSS下载链接。'."\n"
.'>该字段允许用户填写文件流或OSS下载链接。当填写OSS下载链接时，请确保该OSS链接可被公开访问。推荐提供预签名URL。>', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => 'A5B97987-66EA-5563-9599-A2752292****'],
'Id' => ['description' => '资源文件的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'example' => '631478864897630XXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5B97987-66EA-5563-9599-A2752292****\\",\\n \\"Id\\": \\"631478864897630XXXX\\"\\n}","type":"json"}]',
'title' => '创建数据开发文件资源',
'description' => '>该接口不支持批量操作，若FlowSpec中定义了不止一个资源文件，则除第一个以外的后续资源文件均会被忽略。>',
'changeSet' => [
['createdAt' => '2025-05-06T02:37:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateResourceFile' => [
'summary' => '支持用户指定自己的文件（比如jar，py，arhive，file等）创建数据开发资源文件。',
'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' => 'DataWorks工作空间的ID。您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间ID。需要用该参数来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '10000'],
],
[
'name' => 'FileFolderPath',
'in' => 'formData',
'schema' => ['description' => '文件的路径。'."\n"
."\n", 'type' => 'string', 'required' => true, 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2'],
],
[
'name' => 'FileName',
'in' => 'formData',
'schema' => ['description' => '文件的名称。', 'type' => 'string', 'required' => true, 'example' => 'Filename'],
],
[
'name' => 'FileType',
'in' => 'formData',
'schema' => ['description' => '文件的代码类型。'."\n"
."\n"
.'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n"
.'您也可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'FileDescription',
'in' => 'formData',
'schema' => ['description' => '文件的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'This is a description'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '文件责任人的阿里云用户ID。如果该参数为空，则默认使用调用者的阿里云用户ID。', 'type' => 'string', 'required' => false, 'example' => '1000000000001'],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。您可以在运维中心找到对应类型的任务，右键单击查看代码，查看具体的代码格式。', 'type' => 'string', 'required' => false, 'example' => 'SHOW TABLES;'],
],
[
'name' => 'ResourceFile',
'in' => 'formData',
'schema' => ['description' => 'POP提供的文件上传OSS URL。', 'type' => 'string', 'required' => false, 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', 'isFileTransferUrl' => true],
],
[
'name' => 'OriginResourceName',
'in' => 'formData',
'schema' => ['description' => '原始资源文件的名称。', 'type' => 'string', 'required' => true, 'example' => 'origin_file_name.sql'],
],
[
'name' => 'UploadMode',
'in' => 'formData',
'schema' => ['description' => '文件资源上传模式。目前仅对MaxCompute的File类型文件生效，取值如下：'."\n"
."\n"
.'- true：可下载的资源模式。'."\n"
."\n"
.'- false：在线编辑的文本模式。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'RegisterToCalcEngine',
'in' => 'formData',
'schema' => ['description' => '是否将资源同步上传到计算引擎。', 'type' => 'boolean', 'required' => true, 'example' => 'false'],
],
[
'name' => 'StorageURL',
'in' => 'formData',
'schema' => ['description' => '资源文件在计算引擎上的存储路径，目前只有EMR和CDH用到该字段。EMR格式为[osshdfs]://path/to/object，CDH默认需要填写为/user/admin/lib。', 'type' => 'string', 'required' => false, 'example' => 'oss://oss-cn-shanghai.aliyuncs.com/emr-test'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Data' => ['description' => '文件创建成功后的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001'],
'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建资源文件',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateResourceGroup' => [
'summary' => '创建资源组。',
'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' => '创建通用资源组的名称，必须以字母开头，可包含字母、数字、下划线（_），最多128个字符。', 'type' => 'string', 'required' => true, 'example' => 'common_resource_group'],
],
[
'name' => 'Remark',
'in' => 'formData',
'schema' => ['title' => '创建通用资源组的备注，可包含字母、中文、数字、下划线（_），最多128个字符', 'description' => '创建通用资源组的备注，可包含字母、中文、数字、下划线（_），最多128个字符。', 'type' => 'string', 'required' => false, 'example' => 'Create a serverless resource group for common tasks'],
],
[
'name' => 'PaymentType',
'in' => 'formData',
'schema' => [
'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ',
'description' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'PrePaid',
'enum' => ['PrePaid', 'PostPaid'],
],
],
[
'name' => 'PaymentDurationUnit',
'in' => 'formData',
'schema' => [
'title' => '付费时长单位，Month代表包月，Year代表包年',
'description' => '付费时长单位，Month代表包月，Year代表包年。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Month',
'enum' => ['Month', 'Year'],
],
],
[
'name' => 'PaymentDuration',
'in' => 'formData',
'schema' => ['title' => '付费时长', 'description' => '付费时长。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'AutoRenewEnabled',
'in' => 'formData',
'schema' => ['title' => '是否自动续费', 'description' => '是否自动续费。', 'type' => 'boolean', 'required' => false, 'default' => 'false'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['title' => '资源组规格,单位CU，当资源组付费模式为PRE_PAY时，必填', 'description' => '资源组规格,单位CU，当资源组付费模式为PrePaid时，必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'VpcId',
'in' => 'formData',
'schema' => ['title' => '默认绑定的VPC ID', 'description' => '默认绑定的VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-m2et4f3oc8m****'],
],
[
'name' => 'VswitchId',
'in' => 'formData',
'schema' => ['title' => '默认绑定的交换机ID', 'description' => '默认绑定的交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-uf8usrhs7hjd9****'],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['title' => '客户端幂等性标识，用于保证创建通用资源组操作的幂等性', 'description' => '客户端幂等性标识，用于保证创建通用资源组操作的幂等性。', 'type' => 'string', 'required' => true, 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465'],
],
[
'name' => 'AliyunResourceGroupId',
'in' => 'formData',
'schema' => ['title' => '阿里云资源组ID', 'description' => '阿里云资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2kqofrgXXXXX'],
],
[
'name' => 'AliyunResourceTags',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '阿里云标签列表',
'description' => '阿里云标签列表。',
'type' => 'array',
'items' => [
'title' => '阿里云标签',
'description' => '阿里云标签。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签Key', 'description' => '标签Key。', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['title' => '标签value', 'description' => '标签value。', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'ResourceGroupOrder' => [
'title' => '创建通用资源组的订单信息',
'description' => '创建通用资源组的订单信息。',
'type' => 'object',
'properties' => [
'OrderId' => ['title' => '创建通用资源组的订单ID', 'description' => '创建通用资源组的订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2391982058XXXXX'],
'OrderInstanceId' => ['title' => '创建通用资源组的订单实例ID', 'description' => '创建通用资源组的订单实例ID。', 'type' => 'string', 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX'],
'Id' => ['title' => '创建通用资源组的唯一标识符', 'description' => '创建通用资源组的唯一标识符。', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', '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' => '创建资源组',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已充分了解Dataworks通用资源组的收费方式和[价格](~~2680173~~)。**'."\n"
.'3. **请确保在使用该接口前，已创建服务关联角色'."\n"
.'AliyunServiceRoleForDataWorks。**',
'changeSet' => [
['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'],
],
],
],
],
],
'CreateRoute' => [
'summary' => '创建网络资源的路由。',
'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' => '网络资源ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'DestinationCidr',
'in' => 'formData',
'schema' => ['title' => '路由目的的CIDR', 'description' => '路由目的的CIDR。', 'type' => 'string', 'required' => true, 'example' => '192.168.0.0/16'],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['title' => '所属通用资源组的唯一标识', 'description' => '所属通用资源组的唯一标识', 'type' => 'string', 'required' => false, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'Id' => ['title' => '创建的路由ID', 'description' => '创建的路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', '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' => '创建网络资源的路由',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-02-21T06:57:06.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T08:49:55.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateSecurityStrategy' => [
'summary' => '用于创建新的安全管控策略，支持多种模块和子模块配置。需要Dataworks 租户管理员与安全管理员权限。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '**策略名称**'."\n", 'type' => 'string', 'required' => true, 'example' => '默认数据分析策略'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '**策略描述**'."\n", 'type' => 'string', 'required' => false, 'example' => '控制数据分析模块的查询结果安全行为'],
],
[
'name' => 'SchemaName',
'in' => 'formData',
'schema' => [
'description' => '**Schema模板名称**'."\n",
'type' => 'string',
'required' => true,
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
],
[
'name' => 'ControlModule',
'in' => 'formData',
'schema' => [
'description' => '**管控模块**'."\n",
'type' => 'string',
'required' => true,
'example' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
],
[
'name' => 'ControlSubModule',
'in' => 'formData',
'schema' => [
'description' => '**管控子模块**'."\n",
'type' => 'string',
'required' => false,
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
],
[
'name' => 'ControlDwScope',
'in' => 'formData',
'schema' => [
'description' => '**管控范围（Workspace/Tenant）**'."\n",
'type' => 'string',
'required' => true,
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
],
[
'name' => 'Workspaces',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '关联工作空间ID列表'."\n",
'type' => 'array',
'items' => ['description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1853943'],
'required' => false,
],
],
[
'name' => 'Content',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '策略内容。内容受SecurityStrategySchema约束',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '当前策略关联的SecurityStrategySchema.name',
'type' => 'string',
'required' => true,
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
'DisplayName' => ['description' => '当前策略关联的 SecurityStrategySchema. displayName', 'type' => 'string', 'required' => false, 'example' => '数据分析'],
'DisplayNameEn' => ['description' => '当前策略关联的 SecurityStrategySchema. displayNameEn', 'type' => 'string', 'required' => false, 'example' => 'Data Analysis'],
'ControlModule' => [
'description' => '控制模块。当前策略关联的 SecurityStrategySchema.controlModule',
'type' => 'string',
'required' => true,
'example' => 'DataStudio',
'enum' => ['DataQuery', 'DataStudio'],
],
'ControlSubModule' => [
'description' => '管控子模块。当前策略关联的 SecurityStrategySchema.controlSubModule',
'type' => 'string',
'required' => false,
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
'ControlDwScope' => [
'description' => '管控范围。当前策略关联的 SecurityStrategySchema.name',
'type' => 'string',
'required' => false,
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
'SystemPolicyName' => ['description' => '当前策略关联的 SecurityStrategySchema.name', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY'],
'SystemPolicyDisplayName' => ['description' => '当前策略关联的 SecurityStrategySchema.name', 'type' => 'string', 'required' => false, 'example' => 'Default system generate data query policy'],
'Controllers' => [
'description' => '管控项列表，'."\n"
."\n"
.'注意：合法管控项取决于所选 Schema，参考 Controller定义 及 各Schema管控项列表',
'type' => 'array',
'items' => [
'description' => '管控项',
'type' => 'object',
'properties' => [
'Controller' => ['description' => '管控项标识符，取值见 各Schema管控项列表'."\n", 'type' => 'string', 'required' => false, 'example' => 'viewCount'],
'DisplayName' => ['description' => '显示名称'."\n", 'type' => 'string', 'required' => false, 'example' => '查询结果-单次展示记录值上限'],
'DisplayNameEn' => ['description' => '英文显示名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'Query Results - Single Display Record Limit'],
'Enable' => ['description' => '是否启用该管控项'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'ControllerValueType' => ['description' => '值类型（Boolean/Integer/Long/String）'."\n", 'type' => 'string', 'required' => false, 'example' => 'Integer'],
'UserConfigValue' => ['description' => '用户配置值，类型取决于`ControllerValueType`。', 'type' => 'any', 'required' => false, 'example' => '10'],
'BasicEditionDefaultValue' => ['description' => '基础版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '0'],
'StandardEditionDefaultValue' => ['description' => '标准版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '100000'],
'ProfessionalEditionDefaultValue' => ['description' => '专业版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '200000'],
'EnterpriseEditionDefaultValue' => ['description' => '企业版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '500000'],
'BasicEditionIntervalValue' => [
'description' => '基础版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'required' => false,
],
'StandardEditionIntervalValue' => [
'description' => '标准版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100000'],
'required' => false,
],
'ProfessionalEditionIntervalValue' => [
'description' => '专业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200000'],
'required' => false,
],
'EnterpriseEditionIntervalValue' => [
'description' => '企业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500000'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
'required' => true,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等参数。用于避免多次调用导致操作重复。', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
'Id' => ['description' => '安全策略ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建安全策略',
'description' => '## 请求说明'."\n"
.'- **SchemaName**：根据不同的业务需求选择合适的 Schema 名称。'."\n"
.'- **ControlModule** 和 **ControlSubModule**：指定策略应用的模块及子模块，确保与所选 Schema 匹配。'."\n"
.'- **ControlDwScope**：定义策略的应用范围（租户或工作空间级别）。'."\n"
.'- **Workspaces**：当 `ControlDwScope` 为 `Workspace` 时，必须提供关联的工作空间 ID 列表。'."\n"
.'- **Content.Controllers**：策略内容中的管控项列表需符合所选 Schema 的合法管控项定义。'."\n"
.'- 系统默认策略不允许通过此接口创建。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Id\\": 12345\\n}","type":"json"}]',
],
'CreateSkill' => [
'summary' => '用于在 DataWorks 中创建一个新的 Skill。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '**Skill 名称**，在当前账号下唯一。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-skill'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '**Skill 描述**。'."\n", 'type' => 'string', 'required' => false, 'example' => '数据分析技能'],
],
[
'name' => 'Visibility',
'in' => 'formData',
'schema' => [
'description' => '**可见性级别**。`TENANT`：账号内可见；`PROJECT`：指定项目可见；`USER`：指定用户可见。'."\n",
'type' => 'string',
'required' => false,
'example' => 'TENANT',
'enum' => ['TENANT', 'PROJECT', 'USER'],
],
],
[
'name' => 'VersionNote',
'in' => 'formData',
'schema' => ['description' => '**版本说明**。'."\n", 'type' => 'string', 'required' => false, 'example' => '初版'],
],
[
'name' => 'SkillMdOverride',
'in' => 'formData',
'schema' => ['description' => 'SKILL.md 正文。与 `BundleUrl` 二选一：不提供 bundle 时用本字段创建仅含 SKILL.md 的轻量 Skill。'."\n", 'type' => 'string', 'required' => false, 'example' => '-'],
],
[
'name' => 'BundleUrl',
'in' => 'formData',
'schema' => ['description' => '**bundle.zip 的可下载地址**（http/https）。与 `SkillMdOverride` 二选一。'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://example.com/skill.zip'],
],
[
'name' => 'Extra',
'in' => 'formData',
'style' => 'json',
'schema' => ['description' => '扩展元数据（键值对）。'."\n", 'type' => 'object', 'required' => false, 'example' => '{"appId":"APP_CWJMV36CT9SAFW1QEHX7"}'],
],
[
'name' => 'VisibilityScope',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '可见性范围，按 `Visibility` 取对应字段。'."\n",
'type' => 'object',
'properties' => [
'ProjectIds' => [
'description' => '可见的项目 ID 列表，`Visibility` 为 `PROJECT` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '项目id列表', 'type' => 'string', 'required' => false, 'example' => '12345'],
'required' => false,
],
'UserIds' => [
'description' => '可见的用户 ID 列表，`Visibility` 为 `USER` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '用户 ID', 'type' => 'string', 'required' => false, 'example' => '123456'],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'Skill' => [
'description' => '-',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'Skill 名称。'."\n", 'type' => 'string', 'example' => 'my-skill'],
'GmtCreateTime' => ['description' => '创建时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'CreatorId' => ['description' => '创建者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'ModifierId' => ['description' => '最近修改者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'Description' => ['description' => 'Skill 描述。'."\n", 'type' => 'string', 'example' => '数据分析技能'],
'Visibility' => ['description' => '可见性级别。'."\n", 'type' => 'string', 'example' => 'TENANT'],
'VisibilityScope' => [
'description' => '可见性范围。'."\n",
'type' => 'object',
'properties' => [
'ProjectIds' => [
'description' => '可见的项目 ID 列表。'."\n",
'type' => 'array',
'items' => ['description' => '项目ID', 'type' => 'string', 'example' => '123456'],
],
'UserIds' => [
'description' => '可见的用户 ID 列表，Visibility 为 `USER` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '用户 ID', 'type' => 'string', 'example' => '123456'],
],
],
],
'Body' => ['description' => 'SKILL.md 正文。'."\n", 'type' => 'string', 'example' => '-'],
'GmtModifiedTime' => ['description' => '更新时间，毫秒', 'type' => 'string', 'format' => 'iso8601', 'example' => '12345678901'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建 Skill',
'description' => '## 请求说明'."\n"
.'- `SkillMdOverride` 与 `BundleUrl` 参数二选一，必须提供其中之一。'."\n"
.'- `Visibility` 可设置为 `TENANT`、`PROJECT` 或 `USER`，分别表示账号内可见、指定项目可见或指定用户可见。'."\n"
.'- 当 `Visibility` 设置为 `PROJECT` 时，需要通过 `VisibilityScope.ProjectIds` 指定可见的项目 ID 列表；当设置为 `USER` 时，则需通过 `VisibilityScope.UserIds` 指定可见的用户 ID 列表。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Skill\\": {\\n \\"Name\\": \\"my-skill\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Description\\": \\"数据分析技能\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"VisibilityScope\\": {\\n \\"ProjectIds\\": [\\n \\"123456\\"\\n ],\\n \\"UserIds\\": [\\n \\"123456\\"\\n ]\\n },\\n \\"Body\\": \\"-\\",\\n \\"GmtModifiedTime\\": \\"12345678901\\"\\n }\\n}","type":"json"}]',
],
'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' => '函数文件所在的文件夹路径'."\n"
.'。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/First_Business_Process/function/string_processing'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID，'."\n"
.'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'FileName',
'in' => 'formData',
'schema' => ['description' => '函数的名称'."\n"
.'。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'StringConcat'],
],
[
'name' => 'FunctionType',
'in' => 'formData',
'schema' => [
'description' => '函数的分类，对应创建函数表单中的函数类型一项，'."\n"
.'包括MATH（数学运算函数）、AGGREGATE（聚合函数）、STRING（字符串处理函数）、DATE（日期处理函数）、ANALYTIC（窗口函数）和OTHER（其他函数）。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'STRING',
'enum' => ['MATH', 'AGGREGATE', 'STRING', 'DATE', 'ANALYTIC', 'OTHER'],
],
],
[
'name' => 'ClassName',
'in' => 'formData',
'schema' => ['description' => '函数定义所在的类名，'."\n"
.'对应创建函数表单的类名一项。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat'],
],
[
'name' => 'Resources',
'in' => 'formData',
'schema' => ['description' => '函数引用的资源名列表，对应创建表中的资源列表。'."\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' => '函数用途的说明，'."\n"
.'对应创建函数表单中的描述。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Concatenate several strings to generate a new string'],
],
[
'name' => 'CmdDescription',
'in' => 'formData',
'schema' => ['description' => '函数调用的命令格式，'."\n"
.'对应创建函数表单中的命令格式。', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(String... substrs)'],
],
[
'name' => 'ParameterDescription',
'in' => 'formData',
'schema' => ['description' => '函数入参的说明，'."\n"
.'对应创建函数表单中的参数说明。', 'type' => 'string', 'required' => false, 'example' => 'List of strings to be connected', 'default' => ''],
],
[
'name' => 'ReturnValue',
'in' => 'formData',
'schema' => ['description' => '函数的返回值说明，'."\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' => '函数调用示例，'."\n"
.'对应创建函数表单中的示例。', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(\'a\', \'b\', \'c\')'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，'."\n"
.'即数据开发页面顶部切换工作空间处的英文标识。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'CreateFolderIfNotExists',
'in' => 'formData',
'schema' => ['description' => '当参数中指定的目录（FileFolderPath）在系统中不存在时，'."\n"
.'是否自动创建此目录。取值如下：'."\n"
."\n"
.'- true：若此目录不存在，自动创建此目录'."\n"
."\n"
.'- false：若此目录不存在，调用失败', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => ['description' => '文件创建成功后的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000002'],
'RequestId' => ['description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'Success' => ['description' => '调用是否成功'."\n"
.'。'."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码'."\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.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 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' => '在数据开发中创建函数类型文件',
'summary' => '调用CreateUdfFile，在数据开发中创建函数类型文件。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'CreateWorkflowDefinition' => [
'summary' => '调用该接口，在数据开发指定目录下创建一个工作流。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n"
."\n"
.'> 如何快速获取FlowSpec模板？'."\n"
.'> - 在数据开发中打开工作流->点击右上角“显示Spec，即可得到针对当前工作流的FlowSpec描述。可以基于该FlowSpec描述快速构建符合要求的模板。'."\n"
."\n"
.'>该接口只支持创建Workflow，FlowSpec描述的内部节点不会被创建出来。>', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "kind": "CycleWorkflow",'."\n"
.' "version": "1.1.0",'."\n"
.' "spec": {'."\n"
.' "name": "OpenAPITestWorkflowDemo",'."\n"
.' "type": "CycleWorkflow",'."\n"
.' "workflows": ['."\n"
.' {'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo",'."\n"
.' "runtime": {'."\n"
.' "command": "WORKFLOW"'."\n"
.' }'."\n"
.' },'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "cron": "00 02 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "strategy": {'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "failureStrategy": "Break"'."\n"
.' },'."\n"
.' "name": "OpenAPITestWorkflowDemo",'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "workflow_output",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "OpenAPITestWorkflowDemo"'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "dependencies": []'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '0EF298E5-0940-5AC7-9CB0-6502507****'],
'Id' => ['description' => '数据开发工作流的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'example' => '463497880880954XXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EF298E5-0940-5AC7-9CB0-6502507****\\",\\n \\"Id\\": \\"463497880880954XXXX\\"\\n}","type":"json"}]',
'title' => '创建数据开发工作流',
'description' => '>该接口不支持批量操作，若FlowSpec中定义了不止一个工作流，则除第一个以外的后续工作流均会被忽略。此外，工作流内部定义的节点也会被直接忽略，请调用CreateNode接口依次创建内部节点。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateWorkflowInstances' => [
'summary' => '根据配置创建工作流实例，如补数据工作流实例。',
'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' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
[
'name' => 'EnvType',
'in' => 'formData',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'WorkflowId',
'in' => 'formData',
'schema' => ['description' => '所属工作流的ID。周期任务的WorkflowId均为1。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '名称。', 'type' => 'string', 'required' => true, 'example' => 'WorkflowInstance1'],
],
[
'name' => 'Periods',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '补数据周期设置。',
'type' => 'object',
'properties' => [
'BizDates' => [
'description' => '业务日期列表。可指定多段业务日期（最多7段）。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StartBizDate' => ['description' => '起始业务日期。格式为`yyyy-mm-dd`。', 'type' => 'string', 'required' => true, 'example' => '2024-11-20'],
'EndBizDate' => ['description' => '结束业务日期。格式为`yyyy-mm-dd`。', 'type' => 'string', 'required' => true, 'example' => '2024-11-24'],
],
'required' => false,
'description' => '',
],
'required' => true,
],
'StartTime' => ['description' => '指定开始周期时间，格式为`hh:mm:ss`，24小时制，默认00:00:00。'."\n"
."\n"
.'如果填写此字段需要StartTime与EndTime需要同时填写。', 'type' => 'string', 'required' => false, 'example' => '00:00:00'],
'EndTime' => ['description' => '指定结束周期时间，格式为`hh:mm:ss`，24小时制，默认23:59:59。'."\n"
."\n"
.'如果填写此字段需要StartTime与EndTime需要同时填写。', 'type' => 'string', 'required' => false, 'example' => '23:59:59'],
],
'required' => false,
],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '工作流实例的类型。'."\n"
."\n"
.'- SupplementData：补数据。RootTaskIds与IncludeTaskIds的填写方法随补数据模式而变化，见DefaultRunProperties.Mode参数说明'."\n"
.'- ManualWorkflow：手动业务流程。WorkflowId需要填手动业务流程的WorkflowId，RootTaskIds选填，不填则会使用手动业务流程默认的根节点列表。'."\n"
.'- Manual：手动任务。仅需填RootTaskIds，即为要运行的手动任务列表。'."\n"
.'- SmokeTest：冒烟测试。仅需填RootTaskIds，即为要运行的测试任务列表。'."\n"
.'- TriggerWorkflow：触发式工作流。WorkflowId需要填触发式工作流的WorkflowId，IncludeTaskIds选填，不填则会运行整个工作流。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'SupplementData',
'enum' => ['ManualWorkflow', 'SupplementData', 'Manual', 'SmokeTest', 'TriggerWorkflow'],
],
],
[
'name' => 'WorkflowParameters',
'in' => 'formData',
'schema' => ['description' => '工作流参数，当指定唯一工作流（`WorkflowId != 1`）时生效。若为周期工作流、触发式工作流，格式为key=value，优先级低于任务参数；若为手动业务流程，格式为JSON，优先级高于任务参数。', 'type' => 'string', 'required' => false, 'example' => '"key=value" format:'."\n"
.'key1=value1 key2=value2'."\n"
.'JSON format:'."\n"
.'{"key1":"value1", "key2": "value2"}'],
],
[
'name' => 'TaskParameters',
'in' => 'formData',
'schema' => ['description' => '任务参数，为特定任务设置参数。JSON格式，key为任务ID，value的格式参考任务脚本参数（GetTask接口的结果Task.Script.Parameter）。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "1001": "key1=val2 key2=val2", '."\n"
.' "1002": "key1=val2 key2=val2"'."\n"
.'}'],
],
[
'name' => 'AutoStartEnabled',
'in' => 'formData',
'schema' => ['description' => '创建后是否直接运行，默认为true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DefaultRunProperties',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '运行时配置。',
'type' => 'object',
'properties' => [
'RootTaskIds' => [
'description' => '根任务ID列表。'."\n"
."\n"
.'- Type=SupplementData时。除Mode=Chain的情况外，RootTaskIds均必填。'."\n"
.'- Type=ManualWorkflow时。RootTaskIds选填，不填则会使用手动业务流程默认的根节点列表。'."\n"
.'- Type=Manual时。RootTaskIds必填，即为要运行的手动任务列表。'."\n"
.'- Type=SmokeTest时：RootTaskIds必填，即为要运行的测试任务列表。',
'type' => 'array',
'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
'IncludeTaskIds' => [
'description' => '需要运行的任务ID列表。',
'type' => 'array',
'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
'ExcludeTaskIds' => [
'description' => '不要运行的任务ID列表。',
'type' => 'array',
'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4321'],
'required' => false,
],
'IncludeProjectIds' => [
'description' => '需要运行的项目ID列表。',
'type' => 'array',
'items' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
],
'ExcludeProjectIds' => [
'description' => '不需要运行的项目ID列表。',
'type' => 'array',
'items' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'],
'required' => false,
],
'Mode' => [
'description' => '补数据模式，默认为ManualSelection。Type=SupplementData时必填。'."\n"
.'- General：普通模式，`RootTaskIds`仅能填一个，`IncludeTaskIds`选填，不填会默认包含`RootTaskIds`中的内容'."\n"
.'- ManualSelection：手动选择，`RootTaskIds`能填多个，`IncludeTaskIds`选填，不填会默认包含`RootTaskIds`中的内容'."\n"
.'- Chain：链路，`RootTaskIds`为空，`IncludeTaskIds`填两个id，分别是起始和结束任务'."\n"
.'- AllDownstream：所有下游，`RootTaskIds`仅能填一个',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'ManualSelection',
'default' => 'ManualSelection',
'enum' => ['General', 'ManualSelection', 'Chain', 'AllDownstream', 'Huge'],
],
'Analysis' => [
'description' => '分析配置。Type=SupplementData时必填。',
'type' => 'object',
'properties' => [
'Enabled' => ['description' => '是否开启分析。Type=SupplementData时必填。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Blocked' => ['description' => '分析不通过的情况下是否阻塞运行。Type=SupplementData时必填。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
],
'RunPolicy' => [
'description' => '运行策略。该字段为空则跟随任务配置。',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '开始运行时间，格式为`hh:mm:ss`，24小时制。若设置运行策略，此字段必填。', 'type' => 'string', 'required' => false, 'example' => '00:00:00'],
'EndTime' => ['description' => '结束运行时间，格式为`hh:mm:ss`，24小时制。若设置运行策略，此字段必填。', 'type' => 'string', 'required' => false, 'example' => '23:59:59'],
'Type' => [
'title' => 'Daily 每天',
'description' => '时段类型。若设置运行策略，此字段必填。'."\n"
.'- Daily：每天'."\n"
.'- Weekend：仅周末',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Daily',
'enum' => ['Daily', 'Weekend'],
],
'Immediately' => ['description' => '运行时间在未来是否可以立即运行起来，默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
'Alert' => [
'description' => '报警配置。',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '报警策略',
'description' => '报警策略。'."\n"
.'- Success 成功告警'."\n"
.'- Failure 失败告警'."\n"
.'- SuccessFailure 成功和失败都告警',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Succes',
'enum' => ['Success', 'Failure', 'SuccessFailure'],
],
'NoticeType' => [
'title' => '通知方式',
'description' => '通知方式。'."\n"
.'- Sms：仅短信'."\n"
.'- Mail：仅邮件'."\n"
.'- SmsMail：短信加邮件。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Sms',
'enum' => ['Sms', 'Mail', 'SmsMail'],
],
],
'required' => false,
],
'Parallelism' => ['title' => '并行度', 'description' => '任务并行数。取值2~10时为并行度， 取值1时为串行。Type=SupplementData时必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
'Order' => [
'title' => '运行顺序',
'description' => '运行顺序，默认为Asc。'."\n"
.'- Asc：按业务日期升序。'."\n"
.'- Desc：按业务日期降序。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
'RuntimeResource' => ['title' => '自定义资源组Identifier', 'description' => '自定义调度资源组标识符，该字段为空则跟随任务配置。', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Priority' => ['title' => '自定义优先级', 'description' => '运行优先级，取值范围为1~11。取值越大，优先级越高。（该参数配置只支持手动业务流程与触发式工作流）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'PriorityWeightStrategy' => [
'description' => '优先级权重策略。（该参数配置只支持手动业务流程与触发式工作流）'."\n"
.'- `Disable`：不启用（默认）'."\n"
.'- `Upstream`：当前节点计算上游的权重总和。即层次越深，权重越高。',
'type' => 'string',
'required' => false,
'example' => 'Upstream',
'enum' => ['Disable', 'Upstream'],
],
],
'required' => false,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '创建的原因说明。', 'type' => 'string', 'required' => false, 'example' => 'create for test'],
],
[
'name' => 'Tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'tagValue'],
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'tagKey'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'TagCreationPolicy',
'in' => 'formData',
'schema' => [
'description' => '标签创建策略。'."\n"
.'- Append：追加模式，在继承手动业务流程已有标签的基础上追加新的标签。'."\n"
.'- Overwrite：覆盖模式，不继承手动业务流程已有标签，直接创建标签。',
'type' => 'string',
'required' => false,
'example' => 'Append',
'enum' => ['Append', 'Overwrite'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'OperationId' => ['description' => '操作ID。您可以凭借此字段通过GetCreateWorkflowInstancesResult接口来查询创建操作的结果。', 'type' => 'string', 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\"\\n}","type":"json"}]',
'title' => '创建工作流实例',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-02-27T09:42:14.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteAgent' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要删除的 Agent 名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-agent'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除 Agent',
'summary' => '删除 Agent',
'description' => '## 请求说明'."\n"
.'该 API 用于从 DataWorks 中删除指定名称的 Agent。调用此接口时，必须提供要删除的 Agent 的名称。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\"\\n}","type":"json"}]',
],
'DeleteAlertRule' => [
'summary' => '删除自定义监控报警规则。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '249142',
'abilityTreeNodes' => ['FEATUREdideRJGWWC'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '自定义规则的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '105412'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的 ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75'],
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除自定义规则',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteBusiness' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '268604',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'BusinessId',
'in' => 'formData',
'schema' => ['description' => '业务流程的ID，'."\n"
.'您可以调用[ListBusiness](~~173945~~)接口，根据名称查询对应业务流程的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000001'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n\n"
.'- true：调用成功。'."\n"
."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除业务流程',
'summary' => '调用DeleteBusiness删除业务流程。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteCertificate' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '250936',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '证书文件ID，即证书文件的唯一标识符', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '676303114031776'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '删除的认证文件所属项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '106560'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否删除成功', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'D9A61DC0-B922-421B-B706'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除认证文件',
'summary' => '删除认证文件。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色： 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D9A61DC0-B922-421B-B706\\"\\n}","type":"json"}]',
],
'DeleteComponent' => [
'summary' => '删除组件。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
[
'name' => 'ComponentId',
'in' => 'formData',
'schema' => ['description' => '组件ID。可作为查询导播台组件列表、修改导播台组件的请求参数。', 'type' => 'string', 'required' => true, 'example' => '123123123123'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0000-ABCD-EF****'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除组件',
'description' => '>当这个udf函数被发布后，无法删除，必须先下线再进行删除。>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteComputeResource' => [
'summary' => '根据计算资源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' => '计算资源ID，数据源唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '工作空间id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => 'B56432E0-2112-5C97-88D0-AA0AE5****'."\n"],
'Success' => ['description' => '调用是否成功。'."\n"
.'- true：成功；'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除计算资源',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间下具有如下至少一种角色：'."\n"
.'3. 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteCustomAttribute' => [
'summary' => '删除自定义属性定义。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'description' => '自定义属性的ID', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner'],
],
],
'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' => '7B4D81F1-98CF-500C-8D25-2865EB652EA0'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'Result' => ['title' => '删除结果', 'description' => '删除结果', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除自定义属性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B4D81F1-98CF-500C-8D25-2865EB652EA0\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]',
],
'DeleteDIAlarmRule' => [
'summary' => '删除数据集成报警规则。',
'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' => '告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '1'],
],
[
'name' => 'DIAlarmRuleId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '资源一级ID', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFE****'],
'Success' => ['description' => '请求是否成功，取值如下：'."\n"
.'- true, 请求成功'."\n"
.'- false， 请求失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFE****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据集成同步任务告警规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-06T07:20:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteDIJob' => [
'summary' => '删除数据集成新版任务。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '234098',
'abilityTreeNodes' => ['FEATUREdideBP0OJZ'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11126'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '108864'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11126'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求的唯一标识，用于后续错误排查使用。', 'type' => 'string', 'example' => 'D33D4A51-5845-579A-B4BA-FAADD0F****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D33D4A51-5845-579A-B4BA-FAADD0F****\\"\\n}","type":"json"}]',
'title' => '删除数据集成同步任务',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-10-14T09:34:05.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteDataAssetTag' => [
'summary' => '删除标签。',
'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' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key1', 'maxLength' => 128, 'minLength' => 1],
],
[
'name' => 'Values',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签值列表。',
'type' => 'array',
'items' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'v1', 'maxLength' => 128, 'minLength' => 0],
'required' => false,
'maxItems' => 20,
'minItems' => 0,
],
],
],
'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' => '0bc141151593763597*****'],
'Success' => ['description' => '调用是否成功。', '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc141151593763597*****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除标签',
'description' => '需要购买DataWorks企业版及以上版本才能使用。',
'changeSet' => [],
'ramActions' => [],
],
'DeleteDataQualityAlertRule' => [
'summary' => '根据指定的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' => '数据质量规则模板ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'Success' => ['description' => '告警规则是否删除成功。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除数据质量告警规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteDataQualityEvaluationTask' => [
'summary' => '删除数据质量校验任务。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '250885',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '123123'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', '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' => '删除是否成功。'."\n"
.'- true：成功'."\n"
.'- false：失败', '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.', 'description' => ''],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::DeleteDataQualityScan'],
'returnType' => 'synchronous',
],
'title' => '删除数据质量监控',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteDataQualityRule' => [
'summary' => '删除质量规则。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '247983',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '19715'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '17302'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"],
'Success' => ['description' => '删除是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除质量规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T08:30:40.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteDataQualityRuleTemplate' => [
'summary' => '删除自定义质量规则模版。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248058',
'abilityTreeNodes' => ['FEATUREdideRGVRPF'],
],
'parameters' => [
[
'name' => 'Code',
'in' => 'query',
'schema' => ['description' => '规则模版Code', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_DEFINED:123'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"],
'Success' => ['description' => '删除是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::DeleteDataQualityTemplate'],
'returnType' => 'synchronous',
],
'title' => '删除自定义质量规则模版',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T08:30:40.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteDataQualityScan' => [
'summary' => '删除数据质量监控。',
'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' => '废弃参数，无需配置。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123123'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX'],
'Success' => ['description' => '调用是否成功。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除数据质量监控',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteDataQualityTemplate' => [
'summary' => '根据指定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' => '自定义规则模板ID。', 'type' => 'string', 'required' => false, 'example' => 'USER_DEFINED:2001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115****159376359'],
'Success' => ['description' => '删除成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除数据质量规则模板',
'description' => '## 请求说明'."\n"
."\n"
.'- **Id**: 自定义规则模板的唯一标识符，格式为`USER_DEFINED:`。'."\n"
.'- **ProjectId**: 规则模板所属的DataWorks项目ID。'."\n"
."\n"
.'该API用于从系统中移除不再需要的数据质量规则模板。调用时需确保提供的`Id`和`ProjectId`准确无误，否则可能无法成功执行删除操作或导致非预期的数据丢失。请谨慎使用此功能，并在操作前确认相关模板的确切信息。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteDataSource' => [
'summary' => '根据数据源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' => '数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'B56432E0-2112-5C97-88D0-AA0AE5****'],
'Success' => ['description' => '调用是否成功。'."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据源',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间下具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [
['createdAt' => '2024-12-19T09:00:14.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:DeleteDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteDataSourceSharedRule' => [
'summary' => '根据数据源分享规则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' => '数据源分享规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '22127'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '64B-587A-8CED-969E1973887F****'],
'Success' => ['description' => '数据源分享规则是否删除成功，取值如下：'."\n"
.'- true：请求成功'."\n"
.'- false：请求失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887F****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据源分享规则',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 操作人需要删除一条分享规则，该分享规则是数据源从A空间分享到B空间，则需要操作人在A空间具有数据源分享权限点；或者在B空间具有数据源分享权限点。需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、租户管理员、空间管理员、项目所有者',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:DeleteDataSourceSharedRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteDataset' => [
'summary' => '删除数据集，仅支持删除DataWorks数据集，级联删除对应的数据集版本，要求操作者为数据集的创建者或数据集所在工作空间的管理员',
'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' => '数据集ID，仅支持DataWorks数据集', 'type' => 'string', 'required' => true, 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB****'],
'Success' => ['title' => '是否删除成功', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除数据集',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteDatasetVersion' => [
'summary' => '删除数据集版本，仅支持删除DataWorks非v1版本数据集，v1版本数据集需要通过DeleteDataset接口完成删除'."\n"
.'要求操作者为数据集的创建者或数据集所在工作空间的管理员',
'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' => '数据集版本ID，仅支持DataWorks数据集', 'type' => 'string', 'required' => true, 'example' => ' '."\n"
.'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n"
.':2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX'],
'Success' => ['title' => '是否删除成功', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除数据集版本',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteFile' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '268111',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n\n"
.'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n"
."\n\n"
.'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => ['description' => '文件的ID，'."\n"
.'您可以使用[ListFiles](~~173942~~)接口查询对应文件的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000201'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'DeploymentId' => ['description' => '如果文件已经提交过，那么DeleteFile接口会同时触发一个异步在调度系统删除的流程，需要用DeleteFile接口返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。'."\n"
."\n\n"
.'如果该字段为空，则说明文件已经删除完毕，无需继续轮询。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000001'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码'."\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.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"DeploymentId\\": 1000000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]',
'title' => '删除数据开发中的文件',
'summary' => '调用DeleteFile删除数据开发中的文件。如果文件已经提交过，那么DeleteFile API会同时触发一个异步在调度系统删除的流程，需要用DeleteFile API返回的DeploymentId继续调用GetDeployment轮询被触发的异步删除流程的状态。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteFolder' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '268607',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FolderId',
'in' => 'formData',
'schema' => ['description' => '文件夹的ID，'."\n"
.'您可以通过[ListFolders](~~173955~~)查询对应文件夹的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2eb6f9****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => ' 删除数据开发页面的文件夹',
'summary' => '调用DeleteFolder删除数据开发页面的文件夹。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteFunction' => [
'summary' => '调用该接口，在数据开发中删除指定的udf函数。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => 'UDF函数的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX'],
'Success' => ['description' => '请求是否成功：'."\n"
.'- true（成功）'."\n"
.'- false（失败）', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据开发函数',
'description' => '>当这个udf函数被发布后，无法删除，必须先下线再进行删除。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteLineageRelationship' => [
'summary' => '删除给定的数据地图血缘关系。',
'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' => '血缘关系ID，参考ListLineageRelationships接口返回结果。', 'type' => 'string', 'required' => true, 'example' => '4as3dasf654a'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求'."\n"
.'ID。', 'type' => 'string', 'example' => '952795279527ab****'],
'Success' => ['description' => '请求是否成功，取值如下：'."\n"
."\n"
.'- true, 请求成功'."\n"
.'- false， 请求失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据地图血缘关系',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteMcpServer' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要删除的 MCP Server 名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除MCP Server',
'summary' => '删除 MCP Server',
'description' => '## 请求说明'."\n"
."\n"
.'通过此API，您可以根据提供的MCP Server名称来删除对应的MCP Server实例。请确保您已获得相应的权限，并且在调用前确认要删除的MCP Server名称正确无误。'."\n"
."\n"
.'### 注意事项'."\n"
.'- 删除操作不可逆，请谨慎操作。'."\n"
.'- 确保您拥有足够的权限（`dataworks:DeleteMcpServer`）以执行该操作。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\"\\n}","type":"json"}]',
],
'DeleteMetaCollection' => [
'summary' => '删除给定数据地图中的集合对象，包括数据地图类目和数据专辑。'."\n"
.'删除数据专辑时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。',
'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' => '集合对象Id', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd'],
],
],
'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' => '删除数据地图集合对象',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteMetaEntityDef' => [
'summary' => '删除元数据实体定义（包含纯自定义类型和扩展表类型）',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'EntityType',
'in' => 'formData',
'schema' => ['title' => '实体类型，需匹配 `^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$`', 'description' => '实体类型', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api'],
],
[
'name' => 'Force',
'in' => 'formData',
'schema' => ['title' => '是否强制删除，默认为false', 'description' => '是否强制删除，默认为false'."\n"
.'- true，会自动删除这个实体类型下创建的实体对象'."\n"
.'- false，会校验实体类型下是否有对象存在，如果存在则删除失败', 'type' => 'boolean', 'required' => false, 'example' => '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' => '3C1E755D-B606-57A4-9B9C-7B214E81354C'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除元数据实体定义',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C1E755D-B606-57A4-9B9C-7B214E81354C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteNetwork' => [
'summary' => '解绑并删除通用资源组网络资源。',
'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' => '删除的网络资源ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]',
'title' => '解绑并删除通用资源组网络资源',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteNode' => [
'summary' => '调用此接口，可以删除指定的数据开发节点。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'A1E54497-5122-505E-91C6-BAC14980XXXX'],
'Success' => ['description' => '请求是否成功：'."\n"
."\n"
.'true: 成功； '."\n"
.'false: 失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1E54497-5122-505E-91C6-BAC14980XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据开发节点',
'description' => '>当这个节点被发布后，无法删除，必须先下线再进行删除。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteParameter' => [
'summary' => '删除指定参数。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除参数',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'DeleteProcessDefinition' => [
'summary' => '根据指定的ID删除一个审批流程定义。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244493',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '**流程定义ID**'."\n", 'type' => 'string', 'required' => true, 'example' => 'f0d6d578-a305-40ac-ba1e-0a09f64cbc69'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '**API请求ID**'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除审批流程定义',
'description' => '## 请求说明'."\n"
.'- 该API用于从系统中删除指定ID的审批流程定义。'."\n"
.'- 删除操作不可逆，请谨慎使用。'."\n"
.'- 确保在调用此API前，已经备份了相关数据或确认不再需要该审批流程定义。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]',
],
'DeleteProject' => [
'summary' => '调用DeleteProject接口，删除DataWorks工作空间。',
'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' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n"
."\n"
.'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', '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' => '移除工作空间',
'description' => '需要购买DataWorks基础版及以上版本才能使用。'."\n"
."\n"
.'注意：工作空间删除后会默认加入"控制台-工作空间-回收站"中，静默等待14天后会彻底清除，在此期间无法创建同名工作空间。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteProjectMember' => [
'summary' => '移除工作空间成员及其已授予的工作空间角色。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '534752'],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks账号 ID 。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要移除成员的工作空间进入管理中心页面，进入**租户成员与角色**页面，查看需要从工作空间移除的账号 ID。', 'type' => 'string', 'required' => true, 'example' => '123422344899'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', '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' => '移除工作空间成员',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteProjectMember',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteProjectRole' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244504',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n"
."\n"
.'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Code',
'in' => 'query',
'schema' => ['description' => '自定义角色唯一标识', 'type' => 'string', 'required' => true, 'example' => 'base_role_xxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '5BCD2252-F184-55A8-9675-337C43BE0CD1'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除工作空间自定义角色',
'summary' => '删除空间自定义角色',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BCD2252-F184-55A8-9675-337C43BE0CD1\\"\\n}","type":"json"}]',
],
'DeleteResource' => [
'summary' => '调用此接口，可以删除指定的数据开发文件资源。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '资源文件的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX'],
'Success' => ['description' => '调用是否成功。'."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据开发文件资源',
'description' => '>当这个文件资源被发布后，无法删除，必须先下线再进行删除。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteResourceGroup' => [
'summary' => '删除通用资源组。',
'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' => '资源组唯一标识', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', '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' => '删除通用资源组',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已充分了解Dataworks通用资源组的收费方式和[价格](~~2680173~~)。**'."\n"
.'3. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteRoute' => [
'summary' => '删除网络资源的路由。',
'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' => '网络资源的路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]',
'title' => '删除网络资源的路由',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteSecurityStrategy' => [
'summary' => '根据指定ID删除一个安全策略。需要Dataworks 租户管理员与安全管理员权限。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '安全策略ID'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除安全策略',
'description' => '## 请求说明'."\n"
.'- 该接口用于删除指定ID的安全策略。'."\n"
.'- 系统策略禁止删除。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\"\\n}","type":"json"}]',
],
'DeleteSkill' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要删除的 Skill 名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-skill'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除 Skill',
'summary' => '删除 Skill',
'description' => '## 请求说明'."\n"
."\n"
.'该API用于从DataWorks中删除指定名称的Skill。调用时必须提供要删除的Skill的确切名称。'."\n"
."\n"
.'### 注意事项'."\n"
.'- 确保您拥有足够的权限来执行删除操作。'."\n"
.'- 删除操作不可逆，请谨慎使用。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\"\\n}","type":"json"}]',
],
'DeleteTask' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '247745',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'ProjectEnv',
'in' => 'query',
'schema' => [
'description' => '项目环境。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Prod' => '生产', 'Dev' => '开发'],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'Success' => ['description' => '操作是否成功。', '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' => '删除任务',
'summary' => '删除指定的任务。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteWorkflow' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '253458',
'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '工作流的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'EnvType',
'in' => 'formData',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'ClientUniqueCode',
'in' => 'formData',
'schema' => ['description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', 'type' => 'string', 'required' => false, 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除工作流',
'summary' => '删除指定的工作流。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteWorkflowDefinition' => [
'summary' => '调用该接口，在数据开发中删除指定的工作流。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发工作流的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID，用于后续错误排查使用。', 'type' => 'string', 'example' => 'B17730C0-D959-548A-AE23-E754177CXXXX'],
'Success' => ['description' => '操作是否成功。取值如下：'."\n"
."\n"
.'- true：成功。'."\n"
."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B17730C0-D959-548A-AE23-E754177CXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除数据开发工作流',
'description' => '>当这个工作流被发布后，无法删除，必须先下线再进行删除。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeployFile' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '268115',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => ['description' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。该参数与NodeId参数配置一个即可。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10000001'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '发布的说明信息。', 'type' => 'string', 'required' => false, 'example' => 'First release task'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '待发布文件在调度系统对应的任务ID。'."\n"
.'该参数与FileId参数配置一个即可。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000001'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => ['description' => '发布包的ID。后续需要将该ID作为参数调用[GetDeployment](~~173950~~)接口，获取本次发布的具体情况。', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'The connection does not exist.'],
'Success' => ['description' => '调用是否成功。'."\n"
.'取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 30000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]',
'title' => '部署文件',
'summary' => '发布文件至生产环境。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DetachDataQualityRulesFromEvaluationTask' => [
'summary' => '取消数据质量规则和数据质量校验任务的关联。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '250890',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10002'],
],
[
'name' => 'DataQualityEvaluationTaskId',
'in' => 'formData',
'schema' => ['description' => '关联的质量校验任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'],
],
[
'name' => 'DataQualityRuleIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量规则ID列表。',
'type' => 'array',
'items' => ['description' => '数据质量规则ID。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed6****'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'],
'returnType' => 'synchronous',
],
'title' => '取消数据质量规则与监控的关联关系',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed6****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DisableProcessDefinition' => [
'summary' => '通过指定的流程定义ID来停用一个审批流程定义。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244492',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '流程定义 ID', 'type' => 'string', 'required' => false, 'example' => '11792'],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等串，建议使用UUID。', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9*****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '停用审批流程定义',
'description' => '## 请求说明'."\n"
.'- 该接口用于将指定ID的审批流程定义设置为停用状态。'."\n"
.'- 停用后，该审批流程定义将不再生效，直到被重新启用。'."\n"
.'- 需要提供有效的流程定义ID作为路径参数。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]',
],
'DissociateProjectFromImage' => [
'summary' => '解除镜像与工作空间的关联。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245182',
'abilityTreeNodes' => ['FEATUREdide2SV6DS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'Data' => ['title' => 'API请求结果', 'description' => 'API请求结果', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '解除镜像与工作空间的关联',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'DissociateProjectFromResourceGroup' => [
'summary' => '将资源组和某个工作空间解除绑定。',
'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' => '资源组唯一标识', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['title' => '解绑的工作空间ID', 'description' => '解绑的工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', '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' => '将资源组和某个工作空间解除绑定',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:DissociateProjectFromResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'EnableProcessDefinition' => [
'summary' => '用于启用指定ID的审批流程定义。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244493',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '**流程定义ID**'."\n", 'type' => 'string', 'required' => false, 'example' => 'f0d6d578-a305-40ac-ba1e-0a09f64cbc69'],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等串，建议使用UUID。', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '**API请求响应体**，包含RequestId、Message、Code等字段'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '**API请求ID**'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '启用审批流程定义',
'description' => '## 请求说明'."\n"
.'通过此API可以启用一个已存在的审批流程定义。需要提供流程定义ID作为路径参数。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]',
],
'EstablishRelationTableToBusiness' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '269310',
'abilityTreeNodes' => ['FEATUREdideEPPSOE'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID，'."\n"
.'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n"
."\n\n"
.'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw'],
],
[
'name' => 'BusinessId',
'in' => 'formData',
'schema' => ['description' => '业务流程的ID，'."\n"
.'您可以使用[ListBusiness](~~173945~~)获取对应业务流程的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000001'],
],
[
'name' => 'TableGuid',
'in' => 'formData',
'schema' => ['description' => '表的UUID，'."\n"
.'您可以通过[SearchMetaTables](~~173919~~)获取对应表的UUID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.dw_project.tb1'],
],
[
'name' => 'FolderId',
'in' => 'formData',
'schema' => ['description' => '文件夹的ID，'."\n"
.'您可以使用[GetFolder](~~173952~~)或者[ListFolders](~~173955~~)获取对应文件夹的ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2eb6f9****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '请求是否成功。取值如下：'."\n"
."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '导入表至业务流程',
'summary' => '相当于在数据开发页面右键单击业务流程，选择导入表的操作。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ExecPipelineRunStage' => [
'summary' => '调用此接口，可以执行发布流程的指定阶段。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '267908',
'abilityTreeNodes' => ['FEATUREdide4AR6E0'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '发布流程的唯一标识符', 'type' => 'string', 'required' => true, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'],
],
[
'name' => 'Code',
'in' => 'formData',
'schema' => ['description' => '表示发布流程阶段的代码，具体以GetPipelineRun接口的返回值为准', 'type' => 'string', 'required' => true, 'example' => 'DEV_CHECK'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n"],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。'."\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' => '执行发布流程的指定阶段',
'description' => '>发布流程的阶段是有顺序的，详见GetPipelineRun返回值。不允许跳过或重复执行某一阶段。>'."\n"
.'>执行过程是异步的，返回值只表示触发成功，不表示阶段执行成功。执行结果以GetPipelineRun返回值为准。>'."\n"
.'>低版本的SDK中可能无该接口，此时请使用ExecDeploymentStage接口，参数与该文档一致。>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '名称。', 'type' => 'string', 'required' => true, 'example' => 'WorkflowInstance1'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '责任人的账号ID。', 'type' => 'string', 'required' => true, 'example' => '1000'],
],
[
'name' => 'BizDate',
'in' => 'formData',
'schema' => ['description' => '业务日期。格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'Tasks',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '任务的名称。', 'type' => 'string', 'required' => true, 'example' => 'SQL node.'],
'Type' => ['description' => '任务类型。', 'type' => 'string', 'required' => true, 'example' => 'ODPS_SQL'],
'Owner' => ['description' => '责任人的账号ID。', 'type' => 'string', 'required' => true, 'example' => '1000'],
'Timeout' => ['description' => '任务执行超时时间，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
'Script' => [
'description' => '运行脚本信息。',
'type' => 'object',
'properties' => [
'Content' => ['description' => '脚本内容。', 'type' => 'string', 'required' => false, 'example' => 'echo "helloWorld"'],
'Parameters' => ['description' => '脚本参数列表。', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate'],
],
'required' => false,
],
'RuntimeResource' => [
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'required' => true, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'required' => false, 'example' => '0.25'],
],
'required' => true,
],
'DataSource' => [
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'required' => false, 'example' => 'mysql_test'],
],
'required' => false,
],
'Inputs' => [
'description' => '输入信息。',
'type' => 'object',
'properties' => [
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '变量名称。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
'Value' => ['description' => '变量值。请以`上游任务Output:上游任务输出变量名`的格式来填写。', 'type' => 'string', 'required' => false, 'example' => 'upstream_task_output:key1'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'Outputs' => [
'description' => '输出信息。',
'type' => 'object',
'properties' => [
'TaskOutputs' => [
'description' => '任务输出定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Output' => ['title' => '输出标识符，示例：pre.odps_sql_demo_0', 'description' => '输出标识符。', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'],
],
'required' => false,
],
'required' => false,
],
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '变量名称。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- System'."\n"
.'- Constant'."\n"
.'- NodeOutput'."\n"
.'- PassThrough',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Constant',
'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'],
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'Dependencies' => [
'description' => '依赖信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpstreamOutput' => ['title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', 'description' => '依赖任务的输出标识符。', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'],
],
'required' => false,
],
'required' => false,
],
'ClientUniqueCode' => ['description' => '任务的客户端唯一码，用来唯一标识一个任务。', 'type' => 'string', 'required' => true, 'example' => 'Task_0bc5213917368545132902xxxxxxxx'],
],
'required' => false,
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'WorkflowInstanceId' => ['description' => '工作流实例ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"WorkflowInstanceId\\": 1234\\n}","type":"json"}]',
'title' => '执行临时工作流实例',
'summary' => '根据配置创建一个临时工作流实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-03-20T11:25:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-11T02:31:27.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:ExecuteAdhocWorkflowInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'FindBestMatchSecurityStrategy' => [
'summary' => '根据给定条件查找最匹配的安全策略。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ControlModule',
'in' => 'query',
'schema' => [
'description' => '管控模块，用于匹配安全策略类型',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DataStudio' => 'DataStudio', 'DataQuery' => 'DataQuery'],
'example' => 'DataQuery',
'default' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
],
[
'name' => 'ControlSubModule',
'in' => 'query',
'schema' => [
'description' => '管控子模块，用于匹配安全策略类型',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['MyCatalog' => 'MyCatalog'],
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '**工作空间ID**，用于精确匹配工作空间级别策略'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '**API请求ID**'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
'Data' => [
'description' => '数据对象',
'type' => 'object',
'properties' => [
'SecurityStrategy' => [
'description' => '安全策略',
'type' => 'object',
'properties' => [
'Id' => ['description' => '**策略ID**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
'Name' => ['description' => '**策略名称**'."\n", 'type' => 'string', 'example' => '默认数据分析策略'],
'Description' => ['description' => '**策略描述**'."\n", 'type' => 'string', 'example' => '控制数据分析模块的查询结果安全行为'],
'SchemaName' => [
'description' => '**Schema模板名称**'."\n",
'type' => 'string',
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
'ControlModule' => [
'description' => '**管控模块**'."\n",
'type' => 'string',
'example' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
'ControlSubModule' => [
'description' => '**管控子模块**',
'type' => 'string',
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
'ControlDwScope' => [
'description' => '**管控范围**（Workspace/Tenant）',
'type' => 'string',
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
'Workspaces' => [
'description' => '**关联工作空间ID列表**',
'type' => 'array',
'items' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
],
'Enabled' => ['description' => '**是否启用**', 'type' => 'boolean', 'example' => 'true'],
'Content' => [
'description' => '**策略内容**，参考 StrategyContent定义',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '**Schema名称**'."\n",
'type' => 'string',
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
'DisplayName' => ['description' => '**显示名称**'."\n", 'type' => 'string', 'example' => '数据分析'],
'DisplayNameEn' => ['description' => '**英文显示名称**'."\n", 'type' => 'string', 'example' => 'Data Query'],
'ControlModule' => [
'description' => '**管控模块**'."\n",
'type' => 'string',
'example' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
'ControlSubModule' => [
'description' => '**管控子模块**'."\n",
'type' => 'string',
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
'ControlDwScope' => [
'description' => '**管控范围**'."\n",
'type' => 'string',
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
'SystemPolicyName' => ['description' => '系统策略名称（非空时系统自动创建默认策略）'."\n", 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY'],
'SystemPolicyDisplayName' => ['description' => '系统策略显示名称'."\n", 'type' => 'string', 'example' => 'Default system generate data query policy'],
'Controllers' => [
'description' => '管控项列表，'."\n"
."\n"
.'注意：合法管控项取决于所选 Schema，参考 Controller定义 及 各Schema管控项列表',
'type' => 'array',
'items' => [
'description' => '管控项',
'type' => 'object',
'properties' => [
'Controller' => ['description' => '管控项标识符，取值见 各Schema管控项列表'."\n", 'type' => 'string', 'example' => 'viewCount'],
'DisplayName' => ['description' => '显示名称'."\n", 'type' => 'string', 'example' => '查询结果-单次展示记录值上限'],
'DisplayNameEn' => ['description' => '**英文显示名称**'."\n", 'type' => 'string', 'example' => 'Query Results - Single Display Record Limit'],
'Enable' => ['description' => '**是否启用该管控项**'."\n", 'type' => 'boolean', 'example' => 'true'],
'ControllerValueType' => ['description' => '**值类型（Boolean/Integer/Long/String）**'."\n", 'type' => 'string', 'example' => 'Integer'],
'UserConfigValue' => ['description' => '**用户配置值，类型取决于ControllerValueType**'."\n", 'type' => 'any', 'example' => '20'],
'BasicEditionDefaultValue' => ['description' => '**基础版默认值**'."\n", 'type' => 'any', 'example' => '0'],
'StandardEditionDefaultValue' => ['description' => '**标准版默认值**'."\n", 'type' => 'any', 'example' => '10000'],
'ProfessionalEditionDefaultValue' => ['description' => '专业版默认值'."\n", 'type' => 'any', 'example' => '200000'],
'EnterpriseEditionDefaultValue' => ['description' => '企业版默认值'."\n", 'type' => 'any', 'example' => '500000'],
'BasicEditionIntervalValue' => [
'description' => '基础版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'StandardEditionIntervalValue' => [
'description' => '标准版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'ProfessionalEditionIntervalValue' => [
'description' => '专业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'EnterpriseEditionIntervalValue' => [
'description' => '企业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
],
],
],
],
'OriginPolicyId' => ['description' => '系统默认策略来源ID'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'Creator' => ['description' => '创建者用户ID'."\n", 'type' => 'string', 'example' => '203322746501002787'],
'Updater' => ['description' => '最后更新者用户ID'."\n", 'type' => 'string', 'example' => '207947397706614297'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-05-25T20:46:19'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2026-05-25T20:46:19'],
],
],
'Edition' => ['description' => '购买的Datawork版本'."\n", 'type' => 'string', 'example' => 'STANDARD'],
'EditionDisplayName' => ['description' => '购买的Datawork版本名称'."\n", 'type' => 'string', 'example' => '标准版'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '匹配最佳安全策略',
'description' => '## 请求说明'."\n"
.'该 API 用于根据提供的管控模块、子模块及工作空间ID来查找最适合的安全策略。如果提供了工作空间ID，则会优先匹配指定工作空间级别的策略；否则，将返回租户级别的策略。请注意，系统策略不能被删除或修改。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"Data\\": {\\n \\"SecurityStrategy\\": {\\n \\"Id\\": 16,\\n \\"Name\\": \\"默认数据分析策略\\",\\n \\"Description\\": \\"控制数据分析模块的查询结果安全行为\\",\\n \\"SchemaName\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"Workspaces\\": [\\n 12345\\n ],\\n \\"Enabled\\": true,\\n \\"Content\\": {\\n \\"Name\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"DisplayName\\": \\"数据分析\\",\\n \\"DisplayNameEn\\": \\"Data Query\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"SystemPolicyName\\": \\"SYSTEM_GENERATE_DEFAULT_DATA_QUERY\\",\\n \\"SystemPolicyDisplayName\\": \\"Default system generate data query policy\\",\\n \\"Controllers\\": [\\n {\\n \\"Controller\\": \\"viewCount\\",\\n \\"DisplayName\\": \\"查询结果-单次展示记录值上限\\",\\n \\"DisplayNameEn\\": \\"Query Results - Single Display Record Limit\\",\\n \\"Enable\\": true,\\n \\"ControllerValueType\\": \\"Integer\\",\\n \\"UserConfigValue\\": \\"20\\",\\n \\"BasicEditionDefaultValue\\": \\"0\\",\\n \\"StandardEditionDefaultValue\\": \\"10000\\",\\n \\"ProfessionalEditionDefaultValue\\": \\"200000\\",\\n \\"EnterpriseEditionDefaultValue\\": \\"500000\\",\\n \\"BasicEditionIntervalValue\\": [\\n 0\\n ],\\n \\"StandardEditionIntervalValue\\": [\\n 0\\n ],\\n \\"ProfessionalEditionIntervalValue\\": [\\n 0\\n ],\\n \\"EnterpriseEditionIntervalValue\\": [\\n 0\\n ]\\n }\\n ]\\n },\\n \\"OriginPolicyId\\": 12,\\n \\"Creator\\": \\"203322746501002787\\",\\n \\"Updater\\": \\"207947397706614297\\",\\n \\"CreateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"UpdateTime\\": \\"2026-05-25T20:46:19\\"\\n },\\n \\"Edition\\": \\"STANDARD\\",\\n \\"EditionDisplayName\\": \\"标准版\\"\\n }\\n}","type":"json"}]',
],
'GetAgent' => [
'summary' => '根据名称读取单个 Agent 的详细信息。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要读取的 Skill 名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-skill'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'Agent' => [
'description' => '创建的Agent详情',
'type' => 'object',
'properties' => [
'CreatorId' => ['description' => '创建者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'ModifierId' => ['description' => '最近修改者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'Name' => ['description' => '**Agent 名称。**'."\n", 'type' => 'string', 'example' => 'my-agent'],
'DisplayName' => ['description' => '**展示名称。**'."\n", 'type' => 'string', 'example' => '我的助手'],
'Description' => ['description' => '**描述。**'."\n", 'type' => 'string', 'example' => '数据分析助手'],
'Model' => [
'description' => '**模型配置。**'."\n",
'type' => 'object',
'properties' => [
'ModelName' => ['description' => '模型名称。'."\n", 'type' => 'string', 'example' => 'qwen3-max'],
'Temperature' => ['description' => '采样温度。'."\n", 'type' => 'number', 'format' => 'double', 'example' => '1'],
'TopP' => ['description' => '核采样 Top-P。'."\n", 'type' => 'number', 'format' => 'double', 'example' => '1'],
'MaxTokens' => ['description' => '单次最大输出 Token 数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8192'],
'Stream' => ['description' => '是否流式输出。'."\n", 'type' => 'boolean', 'example' => 'true'],
'Config' => ['description' => '模型的额外配置。'."\n", 'type' => 'object', 'example' => '{}'],
],
],
'SystemPrompt' => ['description' => '**系统提示词。**'."\n", 'type' => 'string', 'example' => '你是一个数据分析助手。'],
'Tools' => [
'description' => '**工具列表。**'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Kind' => ['description' => '**工具类型。**'."\n", 'type' => 'string', 'example' => 'builtin'],
'BuiltinName' => ['description' => '**内置工具名称，Kind 为 `builtin` 时有效。**'."\n", 'type' => 'string', 'example' => 'builtin_sql'],
'McpServerName' => ['description' => '**关联的 MCP Server 名称，Kind 为 `mcp` 时有效。**'."\n", 'type' => 'string', 'example' => 'server-name'],
'McpItems' => [
'description' => '**选用的 MCP 工具项，Kind 为 `mcp` 时有效。**'."\n",
'type' => 'array',
'items' => ['description' => '工具名称，默认为全部', 'type' => 'string', 'example' => 'search_table'],
],
],
'description' => '',
],
],
'Skills' => [
'description' => '技能列表。'."\n",
'type' => 'array',
'items' => [
'description' => '-',
'type' => 'object',
'properties' => [
'Name' => ['description' => '技能名称。'."\n", 'type' => 'string', 'example' => 'my-skill'],
'Version' => ['description' => '技能版本号。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '-'],
],
],
],
'CallableAgents' => [
'description' => '可调用的子 Agent 列表。'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '子 Agent 名称。'."\n", 'type' => 'string', 'example' => 'sub-agent'],
'DisplayName' => ['description' => '子 Agent 展示名称。', 'type' => 'string', 'example' => '子助手'],
'Version' => ['description' => '子 Agent 版本号。', 'type' => 'integer', 'format' => 'int32', 'example' => '-'],
'Source' => ['description' => '子 Agent 来源。', 'type' => 'string', 'example' => 'custom'],
],
'description' => '',
],
],
'RequiredRuntime' => [
'description' => '运行所需的环境依赖。',
'type' => 'array',
'items' => ['description' => '空', 'type' => 'string', 'example' => '-'],
],
'Metadata' => ['description' => '**扩展元数据。**'."\n", 'type' => 'object', 'example' => '{}'],
'Visibility' => ['description' => '**可见性级别。**'."\n", 'type' => 'string', 'example' => 'TENANT'],
'VisibilityScope' => [
'description' => '可见性范围。',
'type' => 'object',
'properties' => [
'ProjectIds' => [
'description' => '可见的项目 ID 列表。'."\n",
'type' => 'array',
'items' => ['description' => '项目id列表', 'type' => 'string', 'example' => 'proj_001'],
],
'UserIds' => [
'description' => '可见的用户 ID 列表。'."\n",
'type' => 'array',
'items' => ['description' => '用户ID', 'type' => 'string', 'example' => '123456'],
],
],
],
'GmtCreateTime' => ['description' => '创建时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'GmtModifiedTime' => ['description' => '最近修改时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '读取 Agent 详情',
'description' => '## 请求说明'."\n"
.'该 API 用于通过指定的 Agent 名称来获取其详细的配置信息，包括但不限于模型配置、系统提示词、工具列表等。请求时需要提供准确的 Agent 名称作为参数。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Agent\\": {\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-agent\\",\\n \\"DisplayName\\": \\"我的助手\\",\\n \\"Description\\": \\"数据分析助手\\",\\n \\"Model\\": {\\n \\"ModelName\\": \\"qwen3-max\\",\\n \\"Temperature\\": 1,\\n \\"TopP\\": 1,\\n \\"MaxTokens\\": 8192,\\n \\"Stream\\": true,\\n \\"Config\\": {}\\n },\\n \\"SystemPrompt\\": \\"你是一个数据分析助手。\\",\\n \\"Tools\\": [\\n {\\n \\"Kind\\": \\"builtin\\",\\n \\"BuiltinName\\": \\"builtin_sql\\",\\n \\"McpServerName\\": \\"server-name\\",\\n \\"McpItems\\": [\\n \\"search_table\\"\\n ]\\n }\\n ],\\n \\"Skills\\": [\\n {\\n \\"Name\\": \\"my-skill\\",\\n \\"Version\\": 0\\n }\\n ],\\n \\"CallableAgents\\": [\\n {\\n \\"Name\\": \\"sub-agent\\",\\n \\"DisplayName\\": \\"子助手\\",\\n \\"Version\\": 0,\\n \\"Source\\": \\"custom\\"\\n }\\n ],\\n \\"RequiredRuntime\\": [\\n \\"-\\"\\n ],\\n \\"Metadata\\": {},\\n \\"Visibility\\": \\"TENANT\\",\\n \\"VisibilityScope\\": {\\n \\"ProjectIds\\": [\\n \\"proj_001\\"\\n ],\\n \\"UserIds\\": [\\n \\"123456\\"\\n ]\\n },\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]',
],
'GetAgentSessionArtifactMeta' => [
'summary' => '根据会话ID和文件路径获取Artifact的元信息及正文内容。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '900335678024'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '会话 ID，必填', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34'],
'ArtifactPath' => ['description' => '产出路径，必填', 'type' => 'string', 'required' => false, 'example' => 'mock/mock_report.md'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 `trace_id`，与日志可关联'."\n", 'type' => 'string', 'example' => 'CE70C54F-A3BD-5C19-88EF-2A7D3451C449'],
'JsonRpcResponse' => [
'description' => 'JSON-PRC的返回结果',
'type' => 'object',
'properties' => [
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0'."\n", 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显'."\n", 'type' => 'string', 'example' => '300010555'],
'Result' => [
'description' => '模型产出物Meta信息',
'type' => 'object',
'properties' => [
'ArtifactPath' => ['description' => '产出物路径', 'type' => 'string', 'example' => 'mock/mock_report.md'],
'ArtifactName' => ['description' => '产出物名称', 'type' => 'string', 'example' => 'mock_report.md'],
'ArtifactContent' => ['description' => '产出物内容', 'type' => 'string', 'example' => 'This is md content'],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询 Artifact 元信息与内容',
'description' => '## 请求说明'."\n"
.'- 该接口用于根据 `SessionId` 和 `ArtifactPath` 获取单个 Artifact 的元信息及正文内容。'."\n"
.'- `SessionId` 和 `ArtifactPath` 均为必填参数。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE70C54F-A3BD-5C19-88EF-2A7D3451C449\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"300010555\\",\\n \\"Result\\": {\\n \\"ArtifactPath\\": \\"mock/mock_report.md\\",\\n \\"ArtifactName\\": \\"mock_report.md\\",\\n \\"ArtifactContent\\": \\"This is md content\\"\\n }\\n }\\n}","type":"json"}]',
],
'GetAgentSessionTokenUsage' => [
'summary' => '按SessionId聚合查询该会话累计的AIToken用量',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '1033814166'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '会话 ID，必填', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34'],
],
'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' => 'B313938A-4475-599B-98EB-A0875019FD5B'],
'JsonRpcResponse' => [
'description' => 'JSON-PRC的返回结果',
'type' => 'object',
'properties' => [
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'example' => '8212598228302533855'],
'Result' => [
'description' => 'Token用量结果',
'type' => 'object',
'properties' => [
'PromptTokens' => ['description' => '**Prompt 消耗 token 数累计**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'CompletionTokens' => ['description' => '**Completion 生成 token 数累计**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
'ThoughtsTokens' => ['description' => '思考过程 token 数累计'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3000'],
'TotalTokens' => ['description' => '总 token 数累计'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
'CachedTokens' => ['description' => '命中缓存的 token 数累计'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4000'],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询会话Token用量',
'description' => '## 请求说明'."\n"
.'- 本接口用于获取指定会话中各类AI Token（包括prompt、completion、thoughts）的使用量统计，同时提供总token数与缓存命中token数。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B313938A-4475-599B-98EB-A0875019FD5B\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"8212598228302533855\\",\\n \\"Result\\": {\\n \\"PromptTokens\\": 1000,\\n \\"CompletionTokens\\": 2000,\\n \\"ThoughtsTokens\\": 3000,\\n \\"TotalTokens\\": 2000,\\n \\"CachedTokens\\": 4000\\n }\\n }\\n}","type":"json"}]',
],
'GetAlertRule' => [
'summary' => '获取自定义监控告警规则。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '249232',
'abilityTreeNodes' => ['FEATUREdideRJGWWC'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '自定义告警规则ID。', 'type' => 'string', 'required' => false, 'example' => '28547072'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的 ID，用于定位日志、排查问题。', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed****'],
'AlertRule' => [
'description' => '自定义规则详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '自定义规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16035'],
'Name' => ['description' => '自定义规则名。', 'type' => 'string', 'example' => 'error_rule'],
'Owner' => ['description' => '自定义规则的责任人阿里云UID。', 'type' => 'string', 'example' => '279961421580845157'],
'Enabled' => ['description' => '告警规则是否启用。', 'type' => 'boolean', 'example' => 'true'],
'Notification' => [
'description' => '告警通知配置。',
'type' => 'object',
'properties' => [
'SilenceStartTime' => ['description' => '静默开始时间，格式为 HH:mm:ss 。', 'type' => 'string', 'example' => '00:00:00'],
'SilenceEndTime' => ['description' => '静默结束时间，格式为 HH:mm:ss 。', 'type' => 'string', 'example' => '00:00:00'],
'IntervalInMinutes' => ['description' => '告警间隔，单位为分钟，取值范围[5,10000]。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'Maximum' => ['description' => '一个自然日内的告警最大次数，取值范围[1, 10000]。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'Channels' => [
'description' => '告警通道列表。',
'type' => 'array',
'items' => ['description' => '告警通道，枚举值：'."\n"
.'- Mail: 邮件'."\n"
.'- Phone: 电话'."\n"
.'- Sms: 短信'."\n"
.'- Dingding: 钉钉webhook'."\n"
.'- Feishu: 飞书webhook'."\n"
.'- Weixin: 企业微信webhook'."\n"
.'- Webhook: 自定义Webhook', 'type' => 'string', 'example' => 'Sms'],
],
'Receivers' => [
'description' => '告警接收对象。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '告警接收对象类型，枚举值：'."\n"
.'- AliUid: 阿里云UID'."\n"
.'- ShiftSchedule: 值班表'."\n"
.'- TaskOwner: 任务责任人，适用于自定义告警和事件告警'."\n"
.'- Owner: 责任人，适用于基线告警'."\n"
.'- WebhookUrl: 自定义webhookUrl'."\n"
.'- DingdingUrl: 钉钉webhookUrl'."\n"
.'- FeishuUrl: 飞书webhookUrl'."\n"
.'- WeixinUrl: 企业微信webhookUrl', 'type' => 'string', 'example' => 'WebhookUrl'],
'ReceiverValues' => [
'description' => '告警接收对象值。',
'type' => 'array',
'items' => ['description' => '告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云UID，为 ShiftSchedule 时填值班表ID，为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', 'type' => 'string', 'example' => '123123123'],
],
'Extension' => ['description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 {"atAll":true} @所有人。', 'type' => 'string', 'example' => '{"atAll":true}'],
],
],
],
],
],
'TriggerCondition' => [
'description' => '触发告警的条件。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '触发报警的类型，枚举值：'."\n"
.'- Finished: 实例完成'."\n"
.'- UnFinished: 实例未完成'."\n"
.'- Error: 实例出错'."\n"
.'- CycleUnfinished: 实例周期未完成'."\n"
.'- Timeout: 实例超时'."\n"
.'- InstanceTransferComplete: 任务转实例完成'."\n"
.'- InstanceTransferFluctuate: 实例数量波动'."\n"
.'- ExhaustedError: 自动重跑后仍出错'."\n"
.'- InstanceKeyword: 出错实例包含关键词'."\n"
.'- InstanceErrorCount: 出错实例数量'."\n"
.'- InstanceErrorPercentage: 出错实例占比 '."\n"
.'- ResourceGroupPercentage: 资源组利用率'."\n"
.'- ResourceGroupWaitCount: 资源组等资源实例数', 'type' => 'string', 'example' => 'Error'],
'Extension' => [
'description' => '扩展信息，部分触发条件需要配置。',
'type' => 'object',
'properties' => [
'Error' => [
'description' => '出错告警配置。',
'type' => 'object',
'properties' => [
'StreamTaskIds' => [
'description' => '监控实时计算任务时，填入对应的任务ID。',
'type' => 'array',
'items' => ['description' => '实时计算任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123123'],
],
'AutoRerunAlertEnabled' => ['description' => '离线任务由于失败自动重跑，是否产生告警。', 'type' => 'boolean', 'example' => 'false'],
],
],
'Timeout' => [
'description' => '超时告警配置。',
'type' => 'object',
'properties' => [
'TimeoutInMinutes' => ['description' => '超时时间，单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'UnFinished' => [
'description' => '未完成告警配置。',
'type' => 'object',
'properties' => [
'UnFinishedTime' => ['description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'example' => '12:00'],
],
],
'CycleUnfinished' => [
'description' => '周期未完成告警配置。',
'type' => 'object',
'properties' => [
'CycleAndTime' => [
'description' => '周期和时间配置列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CycleId' => ['description' => '周期ID，取值范围为[1,288]。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Time' => ['description' => '超时时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'example' => '12:00'],
],
],
],
],
],
'InstanceErrorCount' => [
'description' => '实例出错数量告警配置。',
'type' => 'object',
'properties' => [
'Count' => ['description' => '出错的实例数，取值范围为[1,10000]。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'InstanceErrorPercentage' => [
'description' => '实例出错比例告警配置。',
'type' => 'object',
'properties' => [
'Percentage' => ['description' => '出错实例占比，取值范围 [1-100]。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'InstanceTransferFluctuate' => [
'description' => '转实例数量波动告警配置。',
'type' => 'object',
'properties' => [
'Trend' => ['description' => '转实例波动类型，枚举值：'."\n"
.'- abs: 绝对值'."\n"
.'- increase: 增长'."\n"
.'- decrease: 下降', 'type' => 'string', 'example' => '10'],
'Percentage' => ['description' => '转实例波动百分比，取值范围[1-100]。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'Target' => [
'description' => '监控对象。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型，枚举值：'."\n"
.'- Task: 任务节点'."\n"
.'- Baseline: 基线'."\n"
.'- Project: 工作空间'."\n"
.'- BizProcess - 业务流程', 'type' => 'string', 'example' => 'Task'],
'Ids' => [
'description' => '监控对象ID列表。',
'type' => 'array',
'items' => ['description' => '监控对象ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '32570'],
],
'AllowTasks' => [
'description' => '监控任务白名单列表。',
'type' => 'array',
'items' => ['description' => '监控任务白名单ID。', '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' => '获取自定义监控告警规则',
'changeSet' => [
['createdAt' => '2024-12-27T03:06:33.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetApplicationContents' => [
'summary' => '查询指定流程实例ID下的资源权限申请内容。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProcessInstanceId',
'in' => 'query',
'schema' => ['description' => '发起申请的审批流程实例ID'."\n", 'type' => 'string', 'required' => true, 'example' => '332066440109224007'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '34267E2E-0335-1A60-A1F0-ADA530890CBA'],
'Data' => [
'description' => '流程实例与关联的申请内容',
'type' => 'object',
'properties' => [
'ProcessInstanceId' => ['description' => '流程实例ID'."\n", 'type' => 'string', 'example' => '332066440109224007'],
'DefSchema' => [
'description' => '资源类型。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'string',
'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'],
'example' => 'MaxCompute',
],
'Reason' => ['description' => '申请理由'."\n", 'type' => 'string', 'example' => '业务需要'],
'ApplicationTime' => ['description' => '申请发起时间，毫秒时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1779675618000'],
'Status' => [
'description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回',
'type' => 'string',
'enumValueTitles' => ['WaitApproval' => '待审批', 'AuthorizeSucceed' => '授权成功', 'AuthorizeFailed' => '授权失败', 'Confirmed' => '待授权', 'Deleted' => '已删除', 'RejectApproval' => '审批拒绝'],
'example' => 'WaitApproval',
],
'Contents' => [
'description' => '申请内容列表',
'type' => 'array',
'items' => [
'description' => '申请内容详情',
'type' => 'object',
'properties' => [
'Id' => ['description' => '申请内容唯一标识', 'type' => 'string', 'example' => 'Y9H7AKFmjhWzLYdZNDZA5'],
'ProcessInstanceId' => ['description' => '发起申请的审批流程实例ID'."\n", 'type' => 'string', 'example' => '777799223'],
'TenantId' => ['description' => '租户ID'."\n", 'type' => 'string', 'example' => '69973837489'],
'ResourceName' => ['description' => '最小权限资源类型。'."\n"
."\n"
.'注意：最小权限资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions). resources[*].isValidLeaf 为true 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => 'table'],
'DefSchema' => [
'description' => '资源类型。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'string',
'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'],
'example' => 'MaxCompute',
],
'AuthMethod' => ['description' => '授权方式。当前只有SEVERLESS_STARROCKS支持指定授权方式：ranger、starrocksManager。'."\n"
."\n"
.'注意：不同资源支持的授权方式不同，统一受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authMethods 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => 'ranger'],
'Resource' => [
'description' => '资源声明。资源的描述受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions) 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'DefSchema' => [
'description' => '资源类型。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'string',
'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'],
'example' => 'MaxCompute',
],
'DefVersion' => ['description' => '资源解析版本受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version约束。'."\n"
."\n"
.'[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => 'v1.0.0'],
'MetaData' => ['description' => '资源元数据声明。'."\n"
."\n"
.'注意：元数据受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources 约束，有效的资源声明需要包含level 0到validLeaf层的全路径元数据声明。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => '"{\\"schema\\":\\"default\\",\\"threeTierModel\\":false,\\"workspace\\":\\"449656\\",\\"project\\":\\"sync_destination\\",\\"table\\":\\"order_table\\",\\"tenant\\":\\"524997424564736\\"}"'],
],
],
'Grantee' => [
'description' => '授权主体描述。 '."\n"
."\n"
.'注意：系统支持的授权主体类型受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'PrincipalType' => [
'description' => '授权主体类型。枚举：'."\n"
."\n"
.'- RamUser'."\n"
.'- RamRole'."\n"
.'- DlfRole',
'type' => 'string',
'enumValueTitles' => ['DlfRole' => 'DlfRole', 'RamUser' => 'RamUser', 'RamRole' => 'RamRole'],
'example' => 'RamRole',
],
'PrincipalId' => ['description' => '授权主体ID，不同主授权主体类型映射ID具有不同语义：'."\n"
."\n"
.'- RamUser：Dataworks UserId'."\n"
."\n"
.'- RamRole "ROLE_"开头的Dataworks UserId'."\n"
."\n"
.'- DlfRole: DlfNext 角色名称', 'type' => 'string', 'example' => 'ROLE_3133343434'],
],
],
'AccessTypes' => [
'description' => '申请的权限列表。'."\n"
."\n"
.'注意：不同层级资源支持权限的申请类型不同，统一受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf和accessTypeRestrictions和authMethodAccessTypes 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'array',
'items' => ['description' => '操作权限', 'type' => 'string', 'example' => 'select'],
],
'FinalAccessTypes' => [
'description' => '最终审批通过的资源操作权限列表',
'type' => 'array',
'items' => ['description' => '通过审批的操作权限', 'type' => 'string', 'example' => 'select'],
],
'ExpirationTime' => ['description' => '权限截止日期，毫秒时间戳'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1785835708000'],
'Status' => [
'description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回',
'type' => 'string',
'enumValueTitles' => ['WaitApproval' => '待审批', 'AuthorizeSucceed' => '授权成功', 'AuthorizeFailed' => '授权失败', 'Confirmed' => '待授权', 'Deleted' => '审批时删除', 'RejectApproval' => '审批拒绝'],
'example' => 'Deleted',
],
'CreateTime' => ['description' => '创建时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1773972024000'],
'UpdateTime' => ['description' => '更新时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1773972024000'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取资源权限申请详情',
'description' => '## 请求说明'."\n"
.'- 该API用于根据提供的`ProcessInstanceId`查询相关的资源权限申请详情。'."\n"
.'- 请求时必须提供有效的`ProcessInstanceId`参数。'."\n"
.'- 返回结果包括申请的基本信息、状态以及具体的申请内容列表。'."\n"
.'- 每个申请内容包含详细的资源信息、授权对象、请求的操作权限等。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34267E2E-0335-1A60-A1F0-ADA530890CBA\\",\\n \\"Data\\": {\\n \\"ProcessInstanceId\\": \\"332066440109224007\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 1779675618000,\\n \\"Status\\": \\"WaitApproval\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"Y9H7AKFmjhWzLYdZNDZA5\\",\\n \\"ProcessInstanceId\\": \\"777799223\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"AuthMethod\\": \\"ranger\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": \\"\\\\\\"{\\\\\\\\\\\\\\"schema\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"threeTierModel\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"workspace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"449656\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sync_destination\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"table\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_table\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tenant\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"524997424564736\\\\\\\\\\\\\\"}\\\\\\"\\"\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamRole\\",\\n \\"PrincipalId\\": \\"ROLE_3133343434\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1785835708000,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 1773972024000,\\n \\"UpdateTime\\": 1773972024000\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetBusiness' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '268608',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'BusinessId',
'in' => 'formData',
'schema' => ['description' => '业务流程的ID，'."\n"
.'您可以调用[ListBusiness](~~173945~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000111'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '业务流程的详情'."\n"
.'。',
'type' => 'object',
'properties' => [
'Owner' => ['description' => '业务流程责任人的阿里云用户ID'."\n"
.'。', 'type' => 'string', 'example' => '20000****'],
'Description' => ['description' => '业务流程的描述信息'."\n"
.'。', 'type' => 'string', 'example' => 'This is my first business process.'],
'ProjectId' => ['description' => '业务流程所在DataWorks工作空间的ID'."\n"
.'。', 'type' => 'string', 'example' => '10000'],
'BusinessId' => ['description' => '业务流程的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001'],
'BusinessName' => ['description' => '业务流程名称，同一个项目空间下的业务流程名称必须唯一'."\n"
.'。', 'type' => 'string', 'example' => 'The first business process'],
'UseType' => ['description' => '业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）'."\n"
.'。', 'type' => 'string', 'example' => 'NORMAL'],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"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' => '查询业务流程的详情',
'summary' => '调用GetBusiness查询业务流程的详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetCatalog' => [
'summary' => '获取数据地图中给定数据目录的详情信息，当前支持dlf与starrocks类型。',
'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' => '数据目录实体ID，当前支持dlf与starrocks类型，可参考ListCatalogs接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n\n"
.'- 对于dlf类型，格式为 `dlf-catalog::catalog_id`'."\n"
."\n"
.'- 对于starrocks类型，格式为`starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`'."\n"
."\n"
.'> 其中 '."\n"
.'`catalog_id`: dlf目录id '."\n"
.'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`catalog_name`: starrocks目录名称', 'type' => 'string', 'required' => true, 'example' => 'dlf-catalog::catalog_id'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Catalog' => ['description' => '数据目录信息。', '$ref' => '#/components/schemas/Catalog'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Catalog\\": {\\n \\"Id\\": \\"dlf-catalog:123456XXX:test_catalog\\\\nstarrocks-catalog:c-abc123xxx:default_catalog\\",\\n \\"Name\\": \\"default_catalog\\",\\n \\"Comment\\": \\"this is a comment\\\\n\\",\\n \\"Type\\": \\"Internal\\",\\n \\"CreateTime\\": 1722073854000,\\n \\"ModifyTime\\": 1722073854000,\\n \\"ParentMetaEntityId\\": \\"dlf\\\\nstarrocks:c-abc123xxx\\"\\n }\\n}","type":"json"}]',
'title' => '获取数据地图数据目录详情',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetCertificate' => [
'summary' => '查看认证文件。',
'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' => '证书文件ID，即证书文件的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '676303114031776'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '证书文件所属项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1065601'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'Certificate' => [
'description' => '证书详情。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '证书文件ID，即证书文件的唯一标识符。', 'description' => '证书文件ID，即证书文件的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '676303114031776'],
'Name' => ['title' => '文件名称', 'description' => '文件名称', 'type' => 'string', 'example' => 'ca1.crt'],
'ProjectId' => ['title' => '证书文件所属项目ID。', 'description' => '证书文件所属项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '177161'],
'Description' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'This is a file'],
'CreateUser' => ['title' => '认证文件的创建者ID', 'description' => '认证文件的创建者ID', 'type' => 'string', 'example' => '1107550004253538'],
'CreateTime' => ['title' => '创建时间（时间戳，单位：毫秒）', 'description' => '创建时间（时间戳，单位：毫秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1730217600000'],
'FileSizeInBytes' => ['title' => '文件的字节大小', 'description' => '文件的字节大小', 'type' => 'integer', 'format' => 'int64', 'example' => '77549'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查看认证文件',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色： 租户所有者、空间管理员、部署、开发、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Certificate\\": {\\n \\"Id\\": 676303114031776,\\n \\"Name\\": \\"ca1.crt\\",\\n \\"ProjectId\\": 177161,\\n \\"Description\\": \\"This is a file\\",\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"CreateTime\\": 1730217600000,\\n \\"FileSizeInBytes\\": 77549\\n }\\n}","type":"json"}]',
],
'GetColumn' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268005',
'abilityTreeNodes' => ['FEATUREdideE9XYA6'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => 'ID', 'description' => 'ID，可参考ListColumns接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}:${字段名称}`，不存在的层级使用空字符占位。'."\n"
."\n"
.'> 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n"
."\n"
.'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n"
."\n"
.'几种常用类型ID格式参考如下'."\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`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`catalog_id`: dlf目录ID '."\n"
.'`project_name`: maxcompute项目名称 '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供，若未开启则使用空字符占位。 '."\n"
.'`table_name`: 表名称 '."\n"
.'`column_name`: 字段名称', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Column' => ['description' => '字段列表。', '$ref' => '#/components/schemas/Column'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据地图数据表字段信息',
'summary' => '获取数据地图数据表给定字段的详细信息。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetColumn',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"Column\\": {\\n \\"Id\\": \\"maxcompute-column:::project_name:[schema_name]:table_name:column_name\\",\\n \\"Name\\": \\"column_name\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:::project_name:[schema_name]:table_name\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]',
],
'GetComponent' => [
'summary' => '获取组件信息。',
'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' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'ComponentId',
'in' => 'query',
'schema' => ['description' => '组件ID。', 'type' => 'string', 'required' => true, 'example' => '1112312312312'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'Component' => [
'description' => 'component模块的JSON序列化。',
'type' => 'object',
'properties' => [
'ComponentId' => ['description' => '数据集加速组件ID。如何获取组件ID，请参见[ListComponents](~~2979566~~)。', 'type' => 'string', 'example' => '43cd873b-235c-44f8-be07-e4d4cf7e73b0'],
'ProjectId' => ['description' => 'DataWorks工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '64623'],
'Name' => ['description' => '名称', 'type' => 'string', 'example' => 'dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '207316543660665792'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2017-04-27T05:37:05Z'],
'ModifyTime' => ['description' => '修改时间（毫秒级时间戳）', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2024-01-26T07:44:21Z'],
'Spec' => ['description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。', 'type' => 'string', 'example' => '{'."\n"
.' "kind": "Component",'."\n"
.' "name": "com1",'."\n"
.' "spec": {'."\n"
.' "components": ['."\n"
.' {'."\n"
.' "name": "test11",'."\n"
.' "id": "8196828925037*****",'."\n"
.' "owner": "054664",'."\n"
.' "description": "",'."\n"
.' "script": {'."\n"
.' "language": "odps-sql",'."\n"
.' "path": "test11",'."\n"
.' "content": "select \'@@{bizdate}\', \'@@{my_input_table}\'",'."\n"
.' "runtime": {'."\n"
.' "command": "SQL_COMPONENT"'."\n"
.' }'."\n"
.' },'."\n"
.' "inputs": ['."\n"
.' {'."\n"
.' "name": "bizdate",'."\n"
.' "type": "string"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "my_input_table",'."\n"
.' "type": "string"'."\n"
.' }'."\n"
.' ],'."\n"
.' "outputs": ['."\n"
.' {'."\n"
.' "name": "my_output_table1",'."\n"
.' "type": "string"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'None'],
'RegionId' => ['description' => '地域信息，通常为服务所在的地域。例如，华东2（上海）为cn-shanghai，华北3（张家口）为cn-zhangjiakou。您无需填写RegionId，会根据调用的Endpoint自动解析。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidComponent.NotFound', 'errorMessage' => 'The specified Component does not exist.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取组件详情',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Component\\": {\\n \\"ComponentId\\": \\"43cd873b-235c-44f8-be07-e4d4cf7e73b0\\",\\n \\"ProjectId\\": 64623,\\n \\"Name\\": \\"dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id\\",\\n \\"Owner\\": \\"207316543660665792\\",\\n \\"CreateTime\\": \\"2017-04-27T05:37:05Z\\",\\n \\"ModifyTime\\": \\"2024-01-26T07:44:21Z\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"kind\\\\\\": \\\\\\"Component\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"com1\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"components\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"8196828925037*****\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"054664\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"content\\\\\\": \\\\\\"select \'@@{bizdate}\', \'@@{my_input_table}\'\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"SQL_COMPONENT\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"inputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"bizdate\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_input_table\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"outputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_output_table1\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Description\\": \\"None\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n}","type":"json"}]',
],
'GetComputeResource' => [
'summary' => '根据计算资源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' => '计算资源 ID，计算资源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11792'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10003'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '9252F32F-D855-549E-8898-61CF5A733050'],
'ComputeResource' => [
'description' => '计算资源的详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '计算资源 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16738'],
'ProjectId' => ['description' => '计算资源所属项目空间 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '52660'],
'Name' => ['description' => '计算资源名称。', 'type' => 'string', 'example' => 'MyCs'],
'Type' => ['description' => '计算资源类型。', 'type' => 'string', 'example' => 'hologres'],
'ConnectionProperties' => ['description' => '计算资源的具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境 envType 信息是此对象的成员属性，包括'."\n"
."\n"
.'- Dev（开发环境）；'."\n"
.'- Prod（生产环境）；'."\n"
.'不同类型的计算资源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，', 'type' => 'any', 'example' => '{'."\n"
.' "envType": "Prod",'."\n"
.' "regionId": "cn-beijing",'."\n"
.' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n"
.' "database": "testdb",'."\n"
.' "securityProtocol": "authTypeNone",'."\n"
.' "authType": "Executor",'."\n"
.' "authIdentity": "1107550004253538"'."\n"
.'}'],
'ConnectionPropertiesMode' => ['description' => '计算资源添加的类别，不同 type 下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n"
.'- InstanceMode 实例模式；'."\n"
.'- UrlMode 连接串模式；'."\n"
.'- CdhMode：CDH 模式。', 'type' => 'string', 'example' => 'InstanceMode'],
'Description' => ['description' => '计算资源描述信息。', 'type' => 'string', 'example' => 'My Description'],
'CreateTime' => ['description' => '创建时间（时间戳格式）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333'],
'CreateUser' => ['description' => '创建者的 ID。', 'type' => 'string', 'example' => '1107550004253538'],
'ModifyTime' => ['description' => '最近修改的时间（时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333'],
'ModifyUser' => ['description' => '修改者 的ID。', 'type' => 'string', 'example' => '1107550004253538'],
'QualifiedName' => ['description' => '计算资源的业务唯一键，以 Holo 举例格式是${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}。', 'type' => 'string', 'example' => '1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb'],
'WhetherDefault' => ['description' => '是否为默认计算资源。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查看计算资源详情',
'description' => '1. 需要购买 DataWorks 基础版及以上版本才能使用。'."\n"
.'2. 需要在 DataWorks 项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、部署、开发、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9252F32F-D855-549E-8898-61CF5A733050\\",\\n \\"ComputeResource\\": {\\n \\"Id\\": 16738,\\n \\"ProjectId\\": 52660,\\n \\"Name\\": \\"MyCs\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"InstanceMode\\",\\n \\"Description\\": \\"My Description\\",\\n \\"CreateTime\\": 1698286929333,\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"ModifyTime\\": 1698286929333,\\n \\"ModifyUser\\": \\"1107550004253538\\",\\n \\"QualifiedName\\": \\"1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb\\",\\n \\"WhetherDefault\\": true\\n }\\n}","type":"json"}]',
],
'GetCreateWorkflowInstancesResult' => [
'summary' => '查询异步创建工作流实例的结果。',
'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' => '操作ID，用于异步查询创建工作流实例的结果，可通过CreateWorkflowInstances接口获得。', 'type' => 'string', 'required' => true, 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Result' => [
'description' => '工作流实例创建结果。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '创建状态。'."\n"
.'- Creating，创建中'."\n"
.'- Created，创建成功'."\n"
.'- CreateFailure，创建失败', 'type' => 'string', 'example' => 'Created'],
'FailureMessage' => ['description' => '失败消息。创建失败后，返回该字段。', 'type' => 'string', 'example' => 'Invalid Param xxx'],
'WorkflowInstanceIds' => [
'description' => '工作流实例ID列表。创建成功后，返回该字段。',
'type' => 'array',
'items' => ['description' => '工作流实例ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
],
'WorkflowTaskInstanceIds' => [
'description' => '工作流实例对应的任务实例ID列表。创建成功后，返回该字段。',
'type' => 'array',
'items' => ['description' => '工作流实例对应的任务实例ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
],
'UnifiedWorkflowInstanceIds' => [
'description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。创建成功后，返回该字段。',
'type' => 'array',
'items' => ['description' => '统一工作流实例Id。', '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' => '获取创建工作流实例结果',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetCreateWorkflowInstancesResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetCustomAttribute' => [
'summary' => '获取自定义属性定义详情。',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'description' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner'],
],
],
'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' => 'BA51C9E6-0CBC-5BB9-92BD-0C4FE66E1717'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'CustomAttribute' => ['title' => '自定义属性定义', 'description' => '自定义属性定义', '$ref' => '#/components/schemas/CustomAttribute'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取自定义属性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA51C9E6-0CBC-5BB9-92BD-0C4FE66E1717\\",\\n \\"Success\\": true,\\n \\"CustomAttribute\\": {\\n \\"Id\\": \\"custom-attribute:biz_owner\\",\\n \\"DisplayName\\": \\"业务负责人\\",\\n \\"Type\\": \\"TEXT\\",\\n \\"EntityTypes\\": [\\n \\"maxcompute-table\\"\\n ],\\n \\"ValueEnums\\": [\\n \\"VALUE_1\\"\\n ],\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"Comment\\": \\"this is a comment\\",\\n \\"CreateTime\\": 1750817692000,\\n \\"ModifyTime\\": 1763380628000\\n }\\n}","type":"json"}]',
],
'GetDIJob' => [
'summary' => '查看数据集成任务。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '234096',
'abilityTreeNodes' => ['FEATUREdideBP0OJZ'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '实例 ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11588'],
],
[
'name' => 'WithDetails',
'in' => 'query',
'schema' => ['description' => '是否返回详细配置信息，详细配置信息包括TransformationRules、TableMappings、JobSettings。默认返回。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID。您可以通过ListProjects接口获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11588'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '创建时间', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '32601'],
'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'description'],
'DestinationDataSourceSettings' => [
'description' => '目的端数据源属性列表。',
'type' => 'array',
'items' => [
'description' => '单个目的端数据源属性。',
'type' => 'object',
'properties' => [
'DataSourceName' => ['description' => '目的端数据源名称。', 'type' => 'string', 'example' => 'dw_mysql'],
],
],
],
'DestinationDataSourceType' => ['description' => '目标端数据源类型，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，LogHub，StarRocks，DataHub，AnalyticDB_For_MySQL，Kafka，Hive。', 'type' => 'string', 'example' => 'Hologres'],
'JobName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'imp_ods_dms_det_dealer_info_df'],
'JobSettings' => [
'description' => '运行时设置。',
'type' => 'object',
'properties' => [
'ChannelSettings' => ['description' => '通道相关任务设置，可以对一些特定通道进行特殊配置，目前支持Holo2Holo（从holo同步到holo），Holo2Kafka（从Holo同步到Kafka）'."\n"
.' 1. Holo2Kafka'."\n"
.' - 示例：{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}'."\n"
.'- kafkaClientProperties：kafka producer参数，写入kafka时使用'."\n"
.'- keyColumns， 需要写入的kafka列取值'."\n"
.'- writeMode，kafka写入格式，目前支持json/canal'."\n"
."\n"
.' 2. Holo2Holo '."\n"
."\n"
.' - 示例： {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n"
."\n"
.'- conflictMode: 写入holo冲突处理策略，replace-覆盖、ignore-忽略'."\n"
.'- writeMode: 写入holo方式，replay-重放、insert-插入'."\n"
.'- dynamicColumnAction：写入holo 动态列方式replay-重放、insert-插入，ignore-忽略', 'type' => 'string', 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'],
'ColumnDataTypeSettings' => [
'description' => '列类型映射。',
'type' => 'array',
'items' => [
'description' => '列类型映射。',
'type' => 'object',
'properties' => [
'DestinationDataType' => ['description' => '目标端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', 'type' => 'string', 'example' => 'text'],
'SourceDataType' => ['description' => '源端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', 'type' => 'string', 'example' => 'bigint'],
],
],
],
'CycleScheduleSettings' => [
'description' => '周期调度设置。',
'type' => 'object',
'properties' => [
'CycleMigrationType' => ['description' => '需要周期调度的同步类型。取值范围：'."\n"
.'- Full：全量'."\n"
.'- OfflineIncremental：离线增量', 'type' => 'string', 'example' => 'Full'],
'ScheduleParameters' => ['description' => '调度参数。', 'type' => 'string', 'example' => 'bizdate=$bizdate'."\n"],
],
],
'DdlHandlingSettings' => [
'description' => 'DDL类型处理数组，包含一系列需要处理的DDL类型以及对应规则。',
'type' => 'array',
'items' => [
'description' => '单条DDL类型处理规则。',
'type' => 'object',
'properties' => [
'Action' => ['description' => '处理动作，可选的枚举值：'."\n"
."\n"
.'- Ignore（忽略）'."\n"
.'- Critical（报错）'."\n"
.'- Normal（正常处理）', 'type' => 'string', 'example' => 'Ignore'],
'Type' => ['description' => 'DDL类型，可选的枚举值：'."\n"
."\n"
.'- RenameColumn（重命名列）'."\n"
.'- ModifyColumn（重命名列）'."\n"
.'- CreateTable（重命名列）'."\n"
.'- TruncateTable（清空表）'."\n"
.'- DropTable（删除表）', 'type' => 'string', 'example' => 'CreateTable'],
],
],
],
'RuntimeSettings' => [
'description' => '运行时设置。',
'type' => 'array',
'items' => [
'description' => '运行时设置。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '设置名称，可选的枚举值：'."\n"
.'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n"
.'- dst.offline.truncate (是否清空目标表）'."\n"
.'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n"
.'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n"
.'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n"
.'- runtime.realtime.concurrent（实时任务并发度）'."\n"
.'- runtime.realtime.failover.minute.dataxcdc (failover失败重启等待时间单位分钟)'."\n"
.'- runtime.realtime.failover.times.dataxcdc (failover失败重启次数）', 'type' => 'string', 'example' => 'runtime.offline.concurrent'."\n"],
'Value' => ['description' => '设置取值。', 'type' => 'string', 'example' => '1'],
],
],
],
],
],
'MigrationType' => ['description' => '同步类型，枚举值有：'."\n"
.'- FullAndRealtimeIncremental（全量和实时增量，整库实时）'."\n"
.'- RealtimeIncremental（实时增量，单表实时）'."\n"
.'- Full（全量，整库离线）'."\n"
.'- OfflineIncremental（离线增量，整库离线）'."\n"
.'- FullAndOfflineIncremental（全量+离线增量，整库离线）', 'type' => 'string', 'example' => 'FullAndRealtimeIncremental'],
'JobType' => ['description' => '任务类型'."\n"
."\n"
.'- DatabaseRealtimeMigration(整库实时):将源端多个库的多个表进行流同步，支持仅全量，仅增量，或全量+增量。'."\n"
."\n"
.'- DatabaseOfflineMigration(整库离线):将源端多个库的多个表进行批同步，支持仅全量，仅增量，或全量+增量。'."\n"
."\n"
.'- SingleTableRealtimeMigration(单表实时):将源端单个表进行流同步。', 'type' => 'string', 'example' => 'DatabaseRealtimeMigration'],
'ProjectId' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'example' => '98330'],
'ResourceSettings' => [
'description' => '资源设置。',
'type' => 'object',
'properties' => [
'OfflineResourceSettings' => [
'description' => '离线同步资源。',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '离线同步任务使用的调度资源组cu。', 'type' => 'number', 'format' => 'double', 'example' => '2.0'],
'ResourceGroupIdentifier' => ['description' => '离线同步使用的数据集成资源组名称。', 'type' => 'string', 'example' => 'di_resourcegroup_v1'],
],
],
'RealtimeResourceSettings' => [
'description' => '实时同步资源。',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '实时同步使用的数据集成资源组cu', 'type' => 'number', 'format' => 'double', 'example' => '2.0'],
'ResourceGroupIdentifier' => ['description' => '实时任务使用的数据集成资源组名称。', 'type' => 'string', 'example' => 'di_resourcegroup_v1'],
],
],
'ScheduleResourceSettings' => [
'description' => '调度资源',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '离线调度任务使用的数据集成资源组cu', 'type' => 'number', 'format' => 'double', 'example' => '2.0'],
'ResourceGroupIdentifier' => ['description' => '离线调度任务使用的调度资源组名称。', 'type' => 'string', 'example' => 'schedual_resourcegroup_v1'],
],
],
],
],
'SourceDataSourceSettings' => [
'description' => '源端数据源设置数组列表。',
'type' => 'array',
'items' => [
'description' => '单个源端数据源设置。',
'type' => 'object',
'properties' => [
'DataSourceName' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'dw_mysql'],
'DataSourceProperties' => [
'description' => '数据源属性。',
'type' => 'object',
'properties' => [
'Encoding' => ['description' => '数据库编码。', 'type' => 'string', 'example' => 'UTF-8'."\n"],
'Timezone' => ['description' => '时区', 'type' => 'string', 'example' => 'GMT+8'."\n"],
],
],
],
],
],
'SourceDataSourceType' => ['description' => '源端数据源类型，枚举值： PolarDB，MySQL，Kafka，LogHub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SQLServer，Doris，ClickHouse。', 'type' => 'string', 'example' => 'Mysql'],
'TableMappings' => [
'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表。'."\n"
."\n"
.'> ['."\n"
.' {'."\n"
.' "SourceObjectSelectionRules":['."\n"
.' {'."\n"
.' "ObjectType":"Database",'."\n"
.' "Action":"Include",'."\n"
.' "ExpressionType":"Exact",'."\n"
.' "Expression":"biz_db"'."\n"
.' },'."\n"
.' {'."\n"
.' "ObjectType":"Schema",'."\n"
.' "Action":"Include",'."\n"
.' "ExpressionType":"Exact",'."\n"
.' "Expression":"s1"'."\n"
.' }, '."\n"
.' {'."\n"
.' "ObjectType":"Table",'."\n"
.' "Action":"Include",'."\n"
.' "ExpressionType":"Exact",'."\n"
.' "Expression":"table1"'."\n"
.' }'."\n"
.' ],'."\n"
.' "TransformationRuleNames":['."\n"
.' {'."\n"
.' "RuleName":"my_database_rename_rule",'."\n"
.' "RuleActionType":"Rename",'."\n"
.' "RuleTargetType":"Schema"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.']',
'type' => 'array',
'items' => [
'description' => '每条规则代表选择需要同步的一个表。',
'type' => 'object',
'properties' => [
'SourceObjectSelectionRules' => [
'description' => '每条规则可选择待同步源端对象的集合，多条规则组成选一个表。',
'type' => 'array',
'items' => [
'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表。',
'type' => 'object',
'properties' => [
'Action' => ['description' => '选择动作，取值范围：Include/Exclude', 'type' => 'string', 'example' => 'Include'],
'Expression' => ['description' => '表达式。', 'type' => 'string', 'example' => 'mysql_table_1'],
'ExpressionType' => ['description' => '表达式类型，取值范围：Exact/Regex', 'type' => 'string', 'example' => 'Exact'],
'ObjectType' => ['description' => '对象类型，可选的枚举值：'."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'example' => 'Table'],
],
],
],
'TransformationRules' => [
'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义。',
'type' => 'array',
'items' => [
'description' => '源端对象上应用的转换规则。',
'type' => 'object',
'properties' => [
'RuleName' => ['description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性。', 'type' => 'string', 'example' => 'rename_rule_1'],
'RuleActionType' => ['description' => '动作类型，可选的枚举值：'."\n"
.'- DefinePrimaryKey（定义主键）'."\n"
.'- Rename（重命名）'."\n"
.'- AddColumn（增加列）'."\n"
.'- HandleDml（DML处理）', 'type' => 'string', 'example' => 'AddColumn'],
'RuleTargetType' => ['description' => '动作作用的目标类型，可选的枚举值：'."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'example' => 'Table'],
],
],
],
],
],
],
'TransformationRules' => [
'description' => '同步对象转换规则定义列表。'."\n"
."\n"
.'> ['."\n"
.' {'."\n"
.' "RuleName":"my_database_rename_rule",'."\n"
.' "RuleActionType":"Rename",'."\n"
.' "RuleTargetType":"Schema",'."\n"
.' "RuleExpression":"{\\"expression\\":\\"${srcDatasoureName}_${srcDatabaseName}\\"}"'."\n"
.' }'."\n"
.']',
'type' => 'array',
'items' => [
'description' => '同步对象转换规则定义列表，列表中每个元素为一条转换规则定义。',
'type' => 'object',
'properties' => [
'RuleActionType' => ['description' => '动作类型，可选的枚举值：'."\n"
.'- DefinePrimaryKey（定义主键）'."\n"
.'- Rename（重命名）'."\n"
.'- AddColumn（增加列）'."\n"
.'- HandleDml（DML处理）'."\n"
.'- DefineIncrementalCondition（定义增量条件）'."\n"
.'- DefineCycleScheduleSettings（定义周期调度设置）'."\n"
.'- DefinePartitionKey（定义分区列）', 'type' => 'string', 'example' => 'Rename'],
'RuleExpression' => ['description' => '规则表达式，json string格式。'."\n"
."\n"
.'1. 重命名规则（Rename）'."\n"
.' - 示例：{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }'."\n"
.' - expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n"
."\n"
.'2. 加列规则（AddColumn) '."\n"
.'- 示例：{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n"
.'- 如不指定，默认规则为不加列不复制。'."\n"
.'- columnName：附加的列名称。'."\n"
.'- columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n"
.'- columnValue：附加的列取值。当columnValueType=Constant时，value为自定义常量，String类型。当columnValueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n"
."\n"
.'3. 指定目标端表的主键列列名（DefinePrimaryKey）'."\n"
.'- 示例：{"columns":\\["ukcolumn1","ukcolumn2"\\]}'."\n"
.'- 如不指定默认使用源端主键列。'."\n"
.'- 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n"
.'- 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n"
."\n"
.'4. DML处理规则（HandleDml）'."\n"
.'- 示例：'."\n"
.'{"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}'."\n"
.'- 如不指定，默认规则为Insert、Update、Delete均为Normal'."\n"
.'- dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n"
.'- dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n"
.'- filterCondition：DML过滤条件，当dmlAction=Filter时使用'."\n"
."\n\n"
.'5. 增量条件（DefineIncrementalCondition）'."\n"
.'- 示例：'."\n"
.'{"where":"id > 0"} '."\n"
.'- 指定增量过滤条件'."\n"
."\n"
.'6. 周期调度参数（DefineCycleScheduleSettings）'."\n"
.'- 示例：'."\n"
.'{"cronExpress":" * * * * * *", "cycleType":"1"}'."\n"
.'- 指定周期任务调度参数'."\n"
."\n"
.'7. 指定分区键（DefinePartitionKey）'."\n"
.'- 示例：'."\n"
.'{"columns":["id"]} '."\n"
.'- 指定分区键', 'type' => 'string', 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}'],
'RuleName' => ['description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一。', 'type' => 'string', 'example' => 'rename_rule_1'],
'RuleTargetType' => ['description' => '动作作用的目标类型，可选的枚举值：'."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'example' => 'Table'],
],
],
],
'JobStatus' => ['description' => '任务状态。'."\n"
.'同步状态，取值范围：'."\n"
.'- Finished：运行成功已结束'."\n"
.'- Failed：运行失败'."\n"
.'- Running：运行中'."\n"
.'- Initialized：初始化完成(未启动）'."\n"
.'- Stopping：停止中'."\n"
.'- Stop：停止', 'type' => 'string', 'example' => 'Running'],
'DIJobId' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'string', 'deprecated' => true, 'example' => '32601'],
'Owner' => ['title' => '任务责任人', 'type' => 'string'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查看数据集成同步任务配置详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-03-27T08:15:26.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-10-15T06:50:20.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-10-14T09:34:05.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"PagingInfo\\": {\\n \\"Id\\": 32601,\\n \\"Description\\": \\"description\\",\\n \\"DestinationDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\"\\n }\\n ],\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobName\\": \\"imp_ods_dms_det_dealer_info_df\\",\\n \\"JobSettings\\": {\\n \\"ChannelSettings\\": \\"{\\\\\\"structInfo\\\\\\":\\\\\\"MANAGED\\\\\\",\\\\\\"storageType\\\\\\":\\\\\\"TEXTFILE\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"APPEND\\\\\\",\\\\\\"partitionColumns\\\\\\":[{\\\\\\"columnName\\\\\\":\\\\\\"pt\\\\\\",\\\\\\"columnType\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"comment\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"fieldDelimiter\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ColumnDataTypeSettings\\": [\\n {\\n \\"DestinationDataType\\": \\"text\\",\\n \\"SourceDataType\\": \\"bigint\\"\\n }\\n ],\\n \\"CycleScheduleSettings\\": {\\n \\"CycleMigrationType\\": \\"Full\\",\\n \\"ScheduleParameters\\": \\"bizdate=$bizdate\\\\n\\"\\n },\\n \\"DdlHandlingSettings\\": [\\n {\\n \\"Action\\": \\"Ignore\\",\\n \\"Type\\": \\"CreateTable\\"\\n }\\n ],\\n \\"RuntimeSettings\\": [\\n {\\n \\"Name\\": \\"runtime.offline.concurrent\\\\n\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"JobType\\": \\"DatabaseRealtimeMigration\\",\\n \\"ProjectId\\": 98330,\\n \\"ResourceSettings\\": {\\n \\"OfflineResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"RealtimeResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"ScheduleResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"schedual_resourcegroup_v1\\"\\n }\\n },\\n \\"SourceDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\",\\n \\"DataSourceProperties\\": {\\n \\"Encoding\\": \\"UTF-8\\\\n\\",\\n \\"Timezone\\": \\"GMT+8\\\\n\\"\\n }\\n }\\n ],\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"TableMappings\\": [\\n {\\n \\"SourceObjectSelectionRules\\": [\\n {\\n \\"Action\\": \\"Include\\",\\n \\"Expression\\": \\"mysql_table_1\\",\\n \\"ExpressionType\\": \\"Exact\\",\\n \\"ObjectType\\": \\"Table\\"\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleActionType\\": \\"AddColumn\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ]\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleExpression\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"${srcDatasoureName}_${srcDatabaseName}\\\\\\"}\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ],\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": \\"32601\\",\\n \\"Owner\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'GetDIJobLog' => [
'summary' => '获取数据集成任务日志。',
'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' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6153616438'],
],
[
'name' => 'FailoverId',
'in' => 'query',
'schema' => ['description' => 'Failover的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '10000'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '分页查询的页码。取值为大于等于1的正整数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'NodeType',
'in' => 'query',
'schema' => ['description' => '节点类型，目前在查看资源组2.0任务中才适用：'."\n"
.'* **MASTER**：获取JobManager的日志。'."\n"
.'* **WORKER**：获取TaskManager的日志。', 'type' => 'string', 'required' => false, 'example' => 'MASTER'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回的日志内容',
'type' => 'object',
'properties' => [
'Log' => ['title' => '资源一级ID', 'description' => '任务日志', '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' => '请求的ID。用于定位日志，排查问题。', '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' => '查看数据集成同步任务的运行日志',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-02-17T09:05:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetDataQualityAlertRule' => [
'summary' => '根据告警规则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' => '数据质量监控告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '113642'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115****159376359'],
'DataQualityAlertRule' => [
'description' => '数据质量监控告警规则。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据质量监控告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '21045'],
'Condition' => ['description' => '数据质量监控告警规则告警条件。', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '90912'],
'Target' => [
'description' => '数据质量监控告警规则关注目标。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象的类型，只支持 `DataQualityScan`。', 'type' => 'string', 'example' => 'DataQualityScan'],
'Ids' => [
'description' => '监控目标ID列表。',
'type' => 'array',
'items' => ['description' => '监控对象ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '113647'],
],
],
],
'Notification' => [
'description' => '告警通知配置。',
'type' => 'object',
'properties' => [
'Channels' => [
'description' => 'Channels中，除可以同时设置Email和Sms外，其他的情况都只能设置一种渠道。',
'type' => 'array',
'items' => [
'description' => '告警通道。'."\n"
.'- Dingding'."\n"
.'- Mail'."\n"
.'- Weixin'."\n"
.'- Feishu'."\n"
.'- Phone'."\n"
.'- Sms'."\n"
.'- Webhook',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Dingding',
],
],
'Receivers' => [
'description' => '告警接收对象。',
'type' => 'array',
'items' => [
'description' => '告警接收对象。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 `{"atAll":true}` @所有人。', 'type' => 'string', 'example' => '{"atAll":true}'],
'ReceiverType' => [
'description' => '告警接收对象类型。'."\n"
.'- ShiftSchedule'."\n"
.'- WebhookUrl'."\n"
.'- FeishuUrl'."\n"
.'- TaskOwner'."\n"
.'- WeixinUrl'."\n"
.'- DingdingUrl'."\n"
.'- DataQualityScanOwner'."\n"
.'- AliUid',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'TaskOwner',
],
'ReceiverValues' => [
'description' => '告警接收对象值。',
'type' => 'array',
'items' => ['description' => '告警接收对象值。'."\n"
.'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n"
.'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n"
.'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据质量告警规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityAlertRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityAlertRule\\": {\\n \\"Id\\": 21045,\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"ProjectId\\": 90912,\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 113647\\n ]\\n },\\n \\"Notification\\": {\\n \\"Channels\\": [\\n \\"Dingding\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"TaskOwner\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'GetDataQualityEvaluationTask' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '250883',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1006455182'],
],
],
'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' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF'],
'DataQualityEvaluationTask' => [
'description' => '数据质量监控详情。',
'type' => 'object',
'properties' => [
'Target' => [
'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget',
'description' => '数据质量监控对象。',
'type' => 'object',
'properties' => [
'Type' => ['title' => '监控对象类型', 'description' => '监控对象类型。'."\n"
.'- Table：表。', 'type' => 'string', 'example' => 'Table'],
'DatabaseType' => [
'title' => '表所属的数据库类型',
'description' => '表所属的数据库类型：'."\n"
.'- maxcompute'."\n"
.'- hologres'."\n"
.'- cdh'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks'."\n"
.'- emr'."\n"
.'- analyticdb_for_postgresql',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'maxcompute',
],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID。', 'type' => 'string', 'example' => 'odps.meta_open_api_test_sz.test_partition_tbl'],
'PartitionSpec' => ['description' => '数据质量监控分区范围设置。', 'type' => 'string', 'example' => 'pt=$[yyyymmdd-1]'],
],
],
'Description' => ['title' => '质量监控任务描述', 'description' => '质量监控任务描述。', 'type' => 'string', 'example' => 'The description of the quality monitoring task.'],
'Trigger' => [
'title' => '数据质量校验任务的触发配置',
'description' => '数据质量校验任务的触发配置。',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '质量监控任务触发类型',
'description' => '质量监控触发类型：'."\n"
."\n"
.'- ByManual：手动触发'."\n"
.'- ByScheduledTaskInstance：调度任务触发'."\n"
.'- ByQualityNode：质量节点触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'ByScheduledTaskInstance',
],
'TaskIds' => [
'title' => '调度任务Ids',
'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效。',
'type' => 'array',
'items' => ['description' => '调度任务Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '30001'],
],
],
],
'RuntimeConf' => ['title' => '扩展配置', 'description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n"
."\n"
.'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n"
.'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n"
.' + HIVE_SQL'."\n"
.' + SPARK_SQL', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'."\n"],
'Id' => ['title' => '资源一级ID', 'description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2178'],
'Name' => ['title' => '质量监控任务名称', 'description' => '质量监控任务名称。', 'type' => 'string', 'required' => true, 'example' => 'OpenAPI create a data quality monitoring test'],
'ProjectId' => ['title' => '项目空间Id', 'description' => '项目空间Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '2626'],
'Hooks' => [
'title' => '回调设置',
'description' => '回调设置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => 'Hook类型',
'description' => 'Hook类型，目前只支持一种：'."\n"
."\n"
.'- BlockTaskInstance：阻塞调度任务继续运行，数据质量监控是由调度任务触发的，那么在数据质量监控运行完成之后，会根据Hook.Condition来判断是否阻塞调度任务继续运行。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'BlockTaskInstance',
],
'Condition' => ['title' => 'Hook触发条件', 'description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n"
."\n"
.'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n"
.'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => '通知订阅配置。',
'type' => 'object',
'properties' => [
'Condition' => ['title' => '通知触发条件', 'description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n"
."\n"
.'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件 '."\n"
.'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', 'type' => 'string', 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")'],
'Notifications' => [
'title' => '通知设置',
'description' => '通知设置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NotificationReceivers' => [
'title' => '告警接收人设置',
'description' => '告警接收人设置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => [
'title' => '告警接收人类型',
'description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n"
."\n"
.'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。',
'type' => 'string',
'enumValueTitles' => ['WebhookUrl' => '自定义webhook地址', 'FeishuUrl' => '飞书通知地址', 'DingdingUrl' => '钉钉群机器人地址', 'WeixinUrl' => '微信通知地址', 'AliUid' => '用户ID'],
'example' => 'DingdingUrl',
],
'Extension' => ['title' => '扩展信息', 'description' => '扩展信息。', 'type' => 'string', 'example' => '{ "atAll": true }'."\n"],
'ReceiverValues' => [
'title' => '告警接收人',
'description' => '告警接收人。',
'type' => 'array',
'items' => ['description' => '接收方取值。'."\n"
."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n"
.'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n"
.'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n"
.'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。', 'type' => 'string', 'example' => 'https://api.fc.aliyuncs.com/webhook'."\n"],
],
],
'description' => '告警接收人设置',
],
],
'NotificationChannels' => [
'title' => '通知方式',
'description' => '通知方式。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Channels' => [
'title' => '通知方式',
'description' => '通知方式。',
'type' => 'array',
'items' => [
'description' => '告警方式'."\n"
."\n"
.'- Mail - 邮件'."\n"
.'- Sms - 短信'."\n"
.'- Phone - 电话'."\n"
.'- Feishu - 飞书'."\n"
.'- Weixin - 微信'."\n"
.'- Dingding - 钉钉'."\n"
.'- Webhook - 自定义Webhook',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Mail',
],
],
],
'description' => '通知方式',
],
],
],
'description' => '通知设置',
],
],
],
],
'DataSourceId' => ['description' => '质量监控任务所使用的数据源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '45238'],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'],
],
'title' => '查询数据质量监控详情',
'summary' => '查询数据质量校验任务详情。',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"DataQualityEvaluationTask\\": {\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.meta_open_api_test_sz.test_partition_tbl\\",\\n \\"PartitionSpec\\": \\"pt=$[yyyymmdd-1]\\"\\n },\\n \\"Description\\": \\"The description of the quality monitoring task.\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 30001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\\\n\\",\\n \\"Id\\": 2178,\\n \\"Name\\": \\"OpenAPI create a data quality monitoring test\\",\\n \\"ProjectId\\": 2626,\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingdingUrl\\",\\n \\"Extension\\": \\"{ \\\\\\"atAll\\\\\\": true }\\\\n\\",\\n \\"ReceiverValues\\": [\\n \\"https://api.fc.aliyuncs.com/webhook\\\\n\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 45238\\n }\\n}","type":"json"}]',
],
'GetDataQualityEvaluationTaskInstance' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '250220',
'abilityTreeNodes' => ['FEATUREdideGK4B66'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据质量监控实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '7227550902'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed67****'],
'DataQualityEvaluationTaskInstance' => [
'description' => '数据质量监控实例详情。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '数据质量监控实例状态。'."\n"
.'- Running：校验中'."\n"
.'- Error：有规则校验出错'."\n"
.'- Passed：所有规则校验通过'."\n"
.'- Warned：有规则触发普通告警阈值'."\n"
.'- Critical：有规则触发严重告警阈值', 'type' => 'string', 'example' => 'Passed'],
'Task' => [
'description' => '数据质量监控。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据质量监控名称。', 'type' => 'string', 'example' => 'Data quality OpenAPI monitoring test'."\n"],
'Notifications' => [
'description' => '通知设置。',
'type' => 'object',
'properties' => [
'Condition' => ['description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n"
."\n"
.'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件 '."\n"
.'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"'],
'Notifications' => [
'description' => '告警方式。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NotificationReceivers' => [
'description' => '接收方取值。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '告警接收人类型。', 'type' => 'string', 'example' => 'DingdingUrl'],
'Extension' => ['description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n"
."\n"
.'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。', 'type' => 'string', 'example' => '{ "atAll": true }'],
'ReceiverValues' => [
'description' => '告警接收人。',
'type' => 'array',
'items' => ['description' => '接收方取值。'."\n"
."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n"
.'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n"
.'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n"
.'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。', 'type' => 'string', 'example' => 'https://api.fc.aliyuncs.com/webhook'],
],
],
'description' => '',
],
],
'NotificationChannels' => [
'description' => '通知方式。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Channels' => [
'description' => '通知方式。',
'type' => 'array',
'items' => ['description' => '告警方式'."\n"
."\n"
.'- Mail - 邮件'."\n"
.'- Sms - 短信'."\n"
.'- Phone - 电话'."\n"
.'- Feishu - 飞书'."\n"
.'- Weixin - 微信'."\n"
.'- Dingding - 钉钉'."\n"
.'- Webhook - 自定义Webhook', 'type' => 'string', 'example' => 'Mail'],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
'Hooks' => [
'description' => '回调设置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Hook类型，目前只支持一种：'."\n"
."\n"
.'- BlockTaskInstance：阻塞调度任务继续运行，数据质量监控是由调度任务触发的，那么在数据质量监控运行完成之后，会根据Hook.Condition来判断是否阻塞调度任务继续运行。', 'type' => 'string', 'example' => 'BlockTaskInstance'],
'Condition' => ['description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n"
."\n"
.'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n"
.'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', 'type' => 'string', 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")'],
],
'description' => '',
],
],
'RuntimeConf' => ['description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n"
."\n"
.'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n"
.'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n"
.' - HIVE_SQL'."\n"
.' - SPARK_SQL', 'type' => 'string', 'example' => '{ "queue": "default" }'],
'Trigger' => [
'description' => '数据质量校验任务的触发配置。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '质量监控触发类型：'."\n"
.'- ByManual：手动触发，默认值'."\n"
.'- ByScheduledTaskInstance：关联调度任务触发', 'type' => 'string', 'example' => 'ByScheduledTaskInstance'],
'TaskIds' => [
'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效。',
'type' => 'array',
'items' => ['description' => '调度任务Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '70006236752324'],
],
],
],
'Target' => [
'description' => '参看 DataQualityTarget示例，数据质量校验任务的监控对象，参考 DataQualityTarget。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型。'."\n"
.'- Table：表', 'type' => 'string', 'example' => 'Table'],
'DatabaseType' => ['description' => '表所属的数据库类型。', 'type' => 'string', 'example' => 'maxcompute'],
'TableGuid' => ['description' => '表在数据地图中的唯一ID。', 'type' => 'string', 'example' => 'odps.api_trace.ods_d_api_log'],
'PartitionSpec' => ['description' => '监控的分区范围。', 'type' => 'string', 'example' => 'pt=$[yyyymmdd-1]'],
],
],
'Description' => ['description' => '数据质量监控的描述信息。', 'type' => 'string', 'example' => 'OpenAPI quality monitoring test'],
'Id' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '28544990'],
'ProjectId' => ['description' => '工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '20629'],
],
],
'Parameters' => ['description' => '数据质量校验执行参数，JSON格式，可用的key如下：'."\n"
.'- triggerTime：触发时间的毫秒时间戳，数据质量监控的数据范围中$[yyyymmdd]表达式的基准时间，必填。', 'type' => 'string', 'example' => '{ "triggerTime": 1733284062000 }'."\n"],
'FinishTime' => ['description' => '实例运行的结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1716344665000'],
'TriggerContext' => ['description' => '实例触发时的上下文信息，JSON格式。可能包含的key如下：'."\n"
.'- TriggerClient：数据质量监控实例的触发来源，常见的如CWF2（调度系统）等，后续有可能会新增。'."\n"
.'- TriggerClientId：关联到来源系统中某个具体的业务资源。比如TriggerClient为CWF2时，这里记录调度任务ID。', 'type' => 'string', 'example' => '{ "triggerClient": "CWF2", "triggerClientId": 70001238945 }'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1716344665000'],
'Id' => ['description' => '数据质量监控实例ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '7234231689'],
'ProjectId' => ['description' => '工作空间的ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '98330'],
'Results' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'Status' => ['type' => 'string', 'description' => ''],
'CreateTime' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'TaskInstanceId' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'Sample' => ['type' => 'string', 'description' => ''],
'Details' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReferencedValue' => ['type' => 'string', 'description' => ''],
'CheckedValue' => ['type' => 'string', 'description' => ''],
'Status' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
'Rule' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'Name' => ['type' => 'string', 'description' => ''],
'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'Enabled' => ['type' => 'boolean', 'description' => ''],
'Severity' => ['type' => 'string', 'description' => ''],
'Description' => ['type' => 'string', 'description' => ''],
'TemplateCode' => ['type' => 'string', 'description' => ''],
'Target' => [
'type' => 'object',
'properties' => [
'Type' => ['type' => 'string', 'description' => ''],
'DatabaseType' => ['type' => 'string', 'description' => ''],
'TableGuid' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'SamplingConfig' => [
'type' => 'object',
'properties' => [
'Metric' => ['type' => 'string', 'description' => ''],
'MetricParameters' => ['type' => 'string', 'description' => ''],
'SettingConfig' => ['type' => 'string', 'description' => ''],
'SamplingFilter' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'CheckingConfig' => [
'type' => 'object',
'properties' => [
'Type' => ['type' => 'string', 'description' => ''],
'ReferencedSamplesFilter' => ['type' => 'string', 'description' => ''],
'Thresholds' => [
'type' => 'object',
'properties' => [
'Expected' => [
'type' => 'object',
'properties' => [
'Value' => ['type' => 'string', 'description' => ''],
'Operator' => ['type' => 'string', 'description' => ''],
'Expression' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'Warned' => [
'type' => 'object',
'properties' => [
'Value' => ['type' => 'string', 'description' => ''],
'Operator' => ['type' => 'string', 'description' => ''],
'Expression' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'Critical' => [
'type' => 'object',
'properties' => [
'Value' => ['type' => 'string', 'description' => ''],
'Operator' => ['type' => 'string', 'description' => ''],
'Expression' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
'ErrorHandlers' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['type' => 'string', 'description' => ''],
'ErrorDataFilter' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
],
'description' => '',
],
],
'description' => '',
],
'description' => '',
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityScanRun'],
],
'title' => '获取数据质量校验任务实例详情',
'summary' => '获取数据质量校验任务实例详情。',
'description' => '需要购买 DataWorks 基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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"}]',
],
'GetDataQualityRule' => [
'summary' => '查询质量规则详情。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247799',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '19715'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID。', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-****'],
'DataQualityRule' => [
'description' => '规则详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16033'],
'Name' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'The table cannot be empty.'."\n"],
'ProjectId' => ['description' => 'DataWorks工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1948'],
'Enabled' => ['description' => '规则是否启用。', 'type' => 'boolean', 'example' => 'true'],
'Severity' => ['description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n"
.'- Normal'."\n"
.'- High', 'type' => 'string', 'example' => 'High'],
'Description' => ['description' => '规则描述信息，最长500个字符。', 'type' => 'string', 'example' => 'this is a odps _sql task'."\n"],
'Target' => [
'description' => '规则所监控的对象。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型'."\n"
."\n"
.'- Table', 'type' => 'string', 'example' => 'Table'],
'DatabaseType' => ['description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'type' => 'string', 'example' => 'maxcompute'],
'TableGuid' => ['description' => '规则所作用的表在数据地图中的唯一ID。', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test'."\n"],
'PartitionSpec' => ['description' => '分区表的分区设置。', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]'."\n"],
],
],
'TemplateCode' => ['description' => '规则所引用的规则模板唯一标识。', 'type' => 'string', 'example' => 'SYSTEM:table:table_count:fixed'],
'SamplingConfig' => [
'description' => '样本采集所需的设置。',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称：'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'example' => 'Max'],
'MetricParameters' => ['description' => '样本采集时，所需的参数。', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n"
.'SET odps.sql.python.version=cp27;'."\n"],
'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符。', 'type' => 'string', 'example' => 'id IS NULL'."\n"],
],
],
'CheckingConfig' => [
'description' => '样本校验设置。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式：'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n"],
'Thresholds' => [
'description' => '阈值设置。',
'type' => 'object',
'properties' => [
'Expected' => [
'description' => '期望的阈值设置。',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。', 'type' => 'string', 'example' => '$checkValue <= 0.01'],
],
],
'Warned' => [
'description' => '普通警告的阈值设置。',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。', 'type' => 'string', 'example' => '$checkValue > 0.01'],
],
],
'Critical' => [
'description' => '严重警告的阈值设置。',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。', 'type' => 'string', 'example' => '$checkValue > 0.05'],
],
],
],
],
],
],
'ErrorHandlers' => [
'description' => '质量规则校验问题处理器列表。',
'type' => 'array',
'items' => [
'description' => '质量规则校验问题处理器。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '处理器类型：'."\n"
.'- SaveErrorData', 'type' => 'string', 'example' => 'SaveErrorData'."\n"],
'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n"],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityScan'],
],
'title' => '查询质量规则详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'extraInfo' => '规则模版Code列表：'."\n"
.'- 自定义SQL：SYSTEM:user_defined_sql'."\n"
."\n"
.'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n"
.'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n"
.'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n"
.'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n"
.'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n"
.'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n"
.'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n"
.'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n"
.'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n"
.'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n"
.'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n"
.'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n"
.'- 表行数，自定义范围：SYSTEM:table:count'."\n"
.'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n"
."\n"
.'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n"
.'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n"
.'- 平均值，自定义范围：SYSTEM:field:avg'."\n"
."\n"
.'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n"
.'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n"
.'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n"
.'- 汇总值，自定义范围：SYSTEM:field:sum'."\n"
."\n"
.'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n"
.'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n"
.'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n"
.'- 最小值，自定义范围：SYSTEM:field:min'."\n"
."\n"
.'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n"
.'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n"
.'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n"
.'- 最大值，自定义范围：SYSTEM:field:max'."\n"
."\n"
.'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n"
.'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n"
.'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n"
."\n"
.'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n"
.'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n"
.'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n"
.'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n"
."\n"
.'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n"
.'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n"
.'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n"
.'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n"
."\n"
.'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n"
.'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n"
.'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n"
.'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n"
.'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n"
.'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n"
."\n"
.'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n"
.'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n"
.'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n"
."\n"
.'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n"
.'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n"
.'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n"
.'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n"
.'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold',
'changeSet' => [
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-19T08:30:40.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"DataQualityRule\\": {\\n \\"Id\\": 16033,\\n \\"Name\\": \\"The table cannot be empty.\\\\n\\",\\n \\"ProjectId\\": 1948,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\\\n\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\\\n\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\\\n\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:table:table_count:fixed\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue <= 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.05\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetDataQualityRuleTemplate' => [
'summary' => '查询质量规则模版详情。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247999',
'abilityTreeNodes' => ['FEATUREdideRGVRPF'],
],
'parameters' => [
[
'name' => 'Code',
'in' => 'query',
'schema' => ['description' => '规则模版Code。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_DEFINED:123'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID。', 'type' => 'string', 'example' => '691CA452-D37A-4E****'],
'DataQualityRuleTemplate' => [
'description' => '规则模版详情。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '规则模版Code。', 'type' => 'string', 'example' => 'USER_DEFINED:123'],
'Name' => ['description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符。', 'type' => 'string', 'example' => 'Table row Count Verification'],
'ProjectId' => ['description' => 'DataWorks工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '4020'],
'SamplingConfig' => [
'description' => '样本采集所需的设置。',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称：'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'example' => 'Max'],
'MetricParameters' => ['description' => '样本采集时，所需的参数。', 'type' => 'string', 'example' => '{"SQL": "select count(1) from table;"}'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n"
.'SET odps.sql.python.version=cp27;'."\n"],
],
],
'CheckingConfig' => [
'description' => '样本校验设置。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式：'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n"],
],
],
'VisibleScope' => ['description' => '模板的可用范围：'."\n"
.'- Tenant：全租户都可用'."\n"
.'- Project：只在当前项目中可用', 'type' => 'string', 'example' => 'Project'],
'DirectoryPath' => ['description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线。', 'type' => 'string', 'example' => '/ods/order_data'],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityTemplate'],
'returnType' => 'synchronous',
],
'title' => '查询质量规则模版详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-19T08:30:40.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4E****\\",\\n \\"DataQualityRuleTemplate\\": {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\",\\n \\"ProjectId\\": 4020,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n}","type":"json"}]',
],
'GetDataQualityScan' => [
'summary' => '获取数据质量监控详情',
'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' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX'],
'DataQualityScan' => [
'description' => '数据质量监控详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'],
'Name' => ['description' => '数据质量监控名称。', 'type' => 'string', 'example' => 'data_quality_scan_001'],
'Description' => ['description' => '数据质量监控描述信息。', 'type' => 'string', 'example' => 'aily data quality scanning of ods tables.'],
'ProjectId' => ['description' => '数据质量监控所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2780068~~)接口获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
'CreateTime' => ['description' => '数据质量监控创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1731550150000'],
'ModifyTime' => ['description' => '数据质量监控最近修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1731550150000'],
'CreateUser' => ['description' => '数据质量监控创建人用户ID。', 'type' => 'string', 'example' => '2374924198591250'],
'ModifyUser' => ['description' => '数据质量监控最近修改人用户ID。', 'type' => 'string', 'example' => '23482597582479'],
'Owner' => ['description' => '数据质量监控负责人用户ID。', 'type' => 'string', 'example' => '231263586109857423'],
'Spec' => ['description' => '数据质量监控的内容的Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', 'type' => 'string', 'example' => '{'."\n"
.' "datasets": ['."\n"
.' {'."\n"
.' "type": "Table",'."\n"
.' "dataSource": {'."\n"
.' "name": "odps_first",'."\n"
.' "envType": "Prod"'."\n"
.' },'."\n"
.' "tables": ['."\n"
.' "ods_d_user_info"'."\n"
.' ],'."\n"
.' "filter": "pt = $[yyyymmdd-1]"'."\n"
.' }'."\n"
.' ],'."\n"
.' "rules": ['."\n"
.' {'."\n"
.' "assertion": "row_count > 0"'."\n"
.' }, {'."\n"
.' "templateId": "SYSTEM:field:null_value:fixed",'."\n"
.' "pass": "when = 0",'."\n"
.' "name": "The id cannot be empty.",'."\n"
.' "severity": "High",'."\n"
.' "identity": "a-customized-data-quality-rule-uuid"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
'Parameters' => [
'description' => '数据质量监控执行参数定义。',
'type' => 'array',
'items' => [
'description' => '参数信息。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '参数名。', 'type' => 'string', 'example' => '10'],
'Name' => ['description' => '参数值。', 'type' => 'string', 'example' => 'e2e_autolabel'],
],
],
],
'ComputeResource' => [
'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '计算引擎名字，唯一标识。', 'type' => 'string', 'example' => 'polardb_to_holo'],
'Runtime' => [
'description' => '数据质量监控在运行时的更多设置。',
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。取值范围：'."\n"
."\n"
.'- Hive：Hive SQL'."\n"
.'- Spark：Spark SQL'."\n"
.'- Kyuubi',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Hive',
],
'HiveConf' => ['description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', 'type' => 'object', 'example' => 'mapreduce.job.queuename=dq_queue'],
'SparkConf' => ['description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', 'type' => 'object', 'example' => 'spark.yarn.queue=dq_queue'."\n"],
],
],
'EnvType' => [
'description' => '计算引擎所属的工作空间环境。取值范围：'."\n"
."\n"
.'- Prod：生产环境'."\n"
.'- Dev：开发环境',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Prod',
],
],
],
'RuntimeResource' => [
'description' => '数据质量监控运行时，使用的资源组。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '资源组ID。', 'type' => 'string', 'example' => '122878'],
'Cu' => ['description' => '资源组预留CU。', 'type' => 'number', 'format' => 'float', 'example' => '10'],
'Image' => ['description' => '运行配置的镜像ID。', 'type' => 'string', 'example' => 'hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008'],
],
],
'Trigger' => [
'description' => '数据质量监控触发配置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '数据质量监控触发方式。取值范围：'."\n"
."\n"
.'- ByManual：手动触发，默认设置'."\n"
.'- BySchedule：调度任务实例触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'BySchedule',
],
'TaskIds' => [
'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。',
'type' => 'array',
'items' => ['description' => '调度任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1023777390'],
],
],
],
'Hooks' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'array',
'items' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'object',
'properties' => [
'Condition' => ['description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n"
."\n"
.'- 指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => 'Hook类型。取值范围：'."\n"
."\n"
.'- BlockTaskInstance：阻塞任务实例调度',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'BlockTaskInstance',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据质量监控详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityScan',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"DataQualityScan\\": {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"data_quality_scan_001\\",\\n \\"Description\\": \\"aily data quality scanning of ods tables.\\",\\n \\"ProjectId\\": 101,\\n \\"CreateTime\\": 1731550150000,\\n \\"ModifyTime\\": 1731550150000,\\n \\"CreateUser\\": \\"2374924198591250\\",\\n \\"ModifyUser\\": \\"23482597582479\\",\\n \\"Owner\\": \\"231263586109857423\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"10\\",\\n \\"Name\\": \\"e2e_autolabel\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"polardb_to_holo\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Prod\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"122878\\",\\n \\"Cu\\": 10,\\n \\"Image\\": \\"hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetDataQualityScanRun' => [
'summary' => '通过指定ID查询数据质量扫描任务的运行详情。',
'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' => '数据质量监控运行记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1006059507'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115****159376359'],
'DataQualityScanRun' => [
'description' => '数据质量监控运行记录。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '运行记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1016440997'],
'CreateTime' => ['description' => '数据质量监控开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000'],
'FinishTime' => ['description' => '数据质量监控运行结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000'],
'Status' => [
'description' => '当前运行状态。'."\n"
.'- Pass'."\n"
.'- Running'."\n"
.'- Error'."\n"
.'- Warn'."\n"
.'- Fail',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Fail',
],
'Scan' => [
'description' => '校验开始时，数据质量监控配置快照。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '21077'],
'Name' => ['description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。'."\n", 'type' => 'string', 'example' => 'Hourly partition quality monitoring'],
'Description' => ['description' => '数据质量校验任务描述，最长65535个字符。'."\n", 'type' => 'string', 'example' => 'This is a hourly run data quality evaluation plan.'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '164024'],
'CreateTime' => ['description' => '数据质量监控创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000'],
'ModifyTime' => ['description' => '数据质量监控更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000'],
'CreateUser' => ['description' => '数据质量监控创建人。', 'type' => 'string', 'example' => '7892346529452'],
'ModifyUser' => ['description' => '数据质量监控最近更新人。', 'type' => 'string', 'example' => '7892346529452'],
'Owner' => ['description' => '数据质量监控责任人。', 'type' => 'string', 'example' => '7892346529452'],
'Spec' => ['description' => '数据质量监控Spec，详情请参见[数据质量Spec配置说明](~~2963394~~)。', 'type' => 'string', 'example' => '{'."\n"
.' "datasets": ['."\n"
.' {'."\n"
.' "type": "Table",'."\n"
.' "dataSource": {'."\n"
.' "name": "odps_first",'."\n"
.' "envType": "Prod"'."\n"
.' },'."\n"
.' "tables": ['."\n"
.' "ods_d_user_info"'."\n"
.' ],'."\n"
.' "filter": "pt = $[yyyymmdd-1]"'."\n"
.' }'."\n"
.' ],'."\n"
.' "rules": ['."\n"
.' {'."\n"
.' "assertion": "row_count > 0"'."\n"
.' }, {'."\n"
.' "templateId": "SYSTEM:field:null_value:fixed",'."\n"
.' "pass": "when = 0",'."\n"
.' "name": "The id cannot be empty.",'."\n"
.' "severity": "High",'."\n"
.' "identity": "a-customized-data-quality-rule-uuid"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
'Parameters' => [
'description' => '数据质量监控的参数设置。',
'type' => 'array',
'items' => [
'description' => '数据质量监控的参数设置。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '参数值。', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]'],
'Name' => ['description' => '参数名。', 'type' => 'string', 'example' => 'dt'],
],
],
],
'ComputeResource' => [
'description' => '数据质量监控计算资源设置。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '计算资源名称，对应到计算资源API的ComputeResource数据结构中的Name属性。', 'type' => 'string', 'example' => 'emr_cluster_001'],
'Runtime' => [
'description' => '数据质量监控在运行时的更多设置。',
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。'."\n"
.'- Hive'."\n"
.'- Spark'."\n"
.'- Kyuubi',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Hive',
],
'SparkConf' => ['description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', 'type' => 'object', 'example' => 'spark.yarn.queue=dq_queue'."\n"],
'HiveConf' => ['description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', 'type' => 'object', 'example' => 'mapreduce.job.queuename=dq_queue'."\n"],
],
],
'EnvType' => [
'description' => '计算引擎所属的工作空间环境。'."\n"
.'- Prod'."\n"
.'- Dev',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Dev',
],
],
],
'RuntimeResource' => [
'description' => '数据质量监控运行时，使用的资源组。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '资源组ID。', 'type' => 'string', 'example' => '60597'],
'Cu' => ['description' => '资源组预留CU。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'Image' => ['description' => '运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxx'],
],
],
'Trigger' => [
'description' => '数据质量监控触发配置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '数据质量监控触发方式。'."\n"
.'- ByManual'."\n"
.'- BySchedule',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'BySchedule',
],
'TaskIds' => [
'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。',
'type' => 'array',
'items' => ['description' => '调度任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1014217266'],
],
],
],
'Hooks' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'array',
'items' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'object',
'properties' => [
'Condition' => ['description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n"
."\n"
.'* 指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }'],
'Type' => [
'description' => 'Hook类型。'."\n"
.'- BlockTaskInstance',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'BlockTaskInstance',
],
],
],
],
],
],
'Parameters' => [
'description' => '实际运行时，使用的参数设置。'."\n",
'type' => 'array',
'items' => [
'description' => '参数设置。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '参数值。', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]'],
'Name' => ['description' => '参数名。', 'type' => 'string', 'example' => 'dt'],
],
],
],
'Results' => [
'description' => '具体每条规则的校验结果。',
'type' => 'array',
'items' => [
'description' => '规则的校验结果。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '校验结果状态。'."\n"
.'- Pass'."\n"
.'- Running'."\n"
.'- Error'."\n"
.'- Warn'."\n"
.'- Fail',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Fail',
],
'Details' => [
'description' => '本次校验的详情。',
'type' => 'array',
'items' => [
'description' => '本次校验的详情。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '最终的比较结果状态。'."\n"
.'- Pass'."\n"
.'- Error'."\n"
.'- Warn'."\n"
.'- Fail',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Fail',
],
'ReferenceValue' => ['description' => '使用引用的样本，用来参与CheckedValue计算的基准值。', 'type' => 'string', 'example' => '0.0'],
'CheckValue' => ['description' => '最终用来与阈值比较的值。', 'type' => 'string', 'example' => '100.0'],
],
],
],
'Sample' => ['description' => '本次校验所使用的样本值。', 'type' => 'string', 'example' => '{'."\n"
.' "value": "100.0"'."\n"
.'}'."\n"],
'CreateTime' => ['description' => '校验结果生成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1725506795000'],
'Rule' => ['description' => '校验开始时，规则Spec快照。', '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'],
'title' => '获取数据质量扫描运行详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityScanRun\\": {\\n \\"Id\\": 1016440997,\\n \\"CreateTime\\": 1706247622000,\\n \\"FinishTime\\": 1706247622000,\\n \\"Status\\": \\"Fail\\",\\n \\"Scan\\": {\\n \\"Id\\": 21077,\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ProjectId\\": 164024,\\n \\"CreateTime\\": 1706247622000,\\n \\"ModifyTime\\": 1706247622000,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ModifyUser\\": \\"7892346529452\\",\\n \\"Owner\\": \\"7892346529452\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"emr_cluster_001\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Dev\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"60597\\",\\n \\"Cu\\": 1,\\n \\"Image\\": \\"i-xxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1014217266\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n },\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"Details\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"ReferenceValue\\": \\"0.0\\",\\n \\"CheckValue\\": \\"100.0\\"\\n }\\n ],\\n \\"Sample\\": \\"{\\\\n \\\\\\"value\\\\\\": \\\\\\"100.0\\\\\\"\\\\n}\\\\n\\",\\n \\"CreateTime\\": 1725506795000,\\n \\"Rule\\": \\"{\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetDataQualityScanRunLog' => [
'summary' => '查询指定数据质量监控任务实例的日志内容。',
'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' => '数据质量监控运行记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['description' => '日志起始位置，相对于文件起始位置的偏移量，单位byte，每次查询至多返回512kb内容。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'LogSegment' => [
'description' => '任务日志信息。',
'type' => 'object',
'properties' => [
'Log' => ['description' => '任务日志。', 'type' => 'string', 'example' => 'Running on Serverless_resource_group_xxxxx'."\n"
.'Begin to check rule ***'],
'NextOffset' => ['description' => '下一段日志的起始偏移量，-1表示已读取完毕。', 'type' => 'integer', 'format' => 'int64', 'example' => '512000'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据质量扫描运行日志',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityScanRunLog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"LogSegment\\": {\\n \\"Log\\": \\"Running on Serverless_resource_group_xxxxx\\\\nBegin to check rule ***\\",\\n \\"NextOffset\\": 512000\\n }\\n}","type":"json"}]',
],
'GetDataQualityTemplate' => [
'summary' => '根据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' => '数据质量规则模板ID。', 'type' => 'string', 'required' => false, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'DataQualityTemplate' => [
'description' => '数据质量规则模板。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据质量规则模板ID。', 'type' => 'string', 'example' => '10001'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '97535'],
'CreateTime' => ['description' => '数据质量规则模板创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1606724043000'],
'ModifyTime' => ['description' => '数据质量规则模板更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1606724043000'],
'CreateUser' => ['description' => '数据质量规则模板创建人。', 'type' => 'string', 'example' => '238428342865'],
'ModifyUser' => ['description' => '数据质量规则模板最近更新人。', 'type' => 'string', 'example' => '238428342865'],
'Spec' => ['description' => '数据质量规则模板的具体配置，具体含义，请参见[数据质量Spec配置说明](~~2963394~~)。', 'type' => 'string', 'example' => '{'."\n"
.' "assertion": "anomaly detection fro id_not_null_cnt",'."\n"
.' "id_not_null_cnt": {'."\n"
.' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n"
.' },'."\n"
.' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n"
.'}'],
'Owner' => ['description' => '数据质量规则模板负责人。', 'type' => 'string', 'example' => '238428342865'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据质量规则模板',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"DataQualityTemplate\\": {\\n \\"Id\\": \\"10001\\",\\n \\"ProjectId\\": 97535,\\n \\"CreateTime\\": 1606724043000,\\n \\"ModifyTime\\": 1606724043000,\\n \\"CreateUser\\": \\"238428342865\\",\\n \\"ModifyUser\\": \\"238428342865\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\",\\n \\"Owner\\": \\"238428342865\\"\\n }\\n}","type":"json"}]',
],
'GetDataSource' => [
'summary' => '根据数据源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' => '数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '16035'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '9252F32F-D855-549E-8898-61CF5A733050'],
'DataSource' => [
'description' => '数据源详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据源的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16738'],
'ProjectId' => ['description' => '数据源所属的项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '52660'],
'Name' => ['description' => '数据源的名称。', 'type' => 'string', 'example' => 'test'],
'Type' => ['description' => '数据源的类型。', 'type' => 'string', 'example' => 'hologres'],
'ConnectionProperties' => ['description' => '数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境envType信息是此对象的成员属性，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）'."\n"
."\n"
.'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', 'type' => 'any', 'example' => '{'."\n"
.' "envType": "Prod",'."\n"
.' "regionId": "cn-beijing",'."\n"
.' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n"
.' "database": "testdb",'."\n"
.' "securityProtocol": "authTypeNone",'."\n"
.' "authType": "Executor",'."\n"
.' "authIdentity": "1107550004253538"'."\n"
.'}'],
'ConnectionPropertiesMode' => ['description' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n"
.'- InstanceMode 实例模式；'."\n"
.'- UrlMode 连接串模式；'."\n"
.'- CdhMode：CDH模式。', 'type' => 'string', 'example' => 'UrlMode'],
'Description' => ['description' => '数据源的描述信息。', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['description' => '数据源的创建时间（时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333'],
'CreateUser' => ['description' => '数据源的创建者ID。', 'type' => 'string', 'example' => '1107550004253538'],
'ModifyTime' => ['description' => '数据源的最近修改时间（时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333'],
'ModifyUser' => ['description' => '数据源的修改者ID。', 'type' => 'string', 'example' => '1107550004253538'],
'QualifiedName' => ['description' => '数据源的业务唯一键，以holo举例格式是`${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`。', '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' => '查看数据源详情',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、部署、开发、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDatabase' => [
'summary' => '获取数据地图给定数据库的详情信息。',
'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' => '数据库实体ID，可参考ListDatabases接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级使用空字符占位。'."\n"
."\n"
.'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n"
."\n"
.'几种常用类型ID格式参考如下'."\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`: dlf目录id。'."\n"
.'> - `instance_id`: 实例ID，对应数据源以实例模式注册时需要提供。'."\n"
.'> - `encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供。'."\n"
.'> - `database_name`: 数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'dlf-database::catalog_id:database_name'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Database' => ['description' => '数据库详情。', '$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' => '获取数据地图数据库详情',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetDataset' => [
'summary' => '获取数据集的详细信息。',
'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' => '数据集ID。', 'type' => 'string', 'required' => true, 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request。', 'type' => 'string', 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Dataset' => ['description' => '数据集信息。', '$ref' => '#/components/schemas/Dataset'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据集详情',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"Success\\": true,\\n \\"Dataset\\": {\\n \\"Id\\": \\"dataworks-dataset:1gxxxqjx155usz3hrv\\",\\n \\"Name\\": \\"test_dataset\\",\\n \\"Comment\\": \\"测试数据集\\",\\n \\"ProjectId\\": 123456,\\n \\"Origin\\": \\"DataWorks\\",\\n \\"DataType\\": \\"COMMON\\",\\n \\"StorageType\\": \\"OSS\\",\\n \\"CreatorId\\": \\"210484359\\",\\n \\"Readme\\": \\"## introduction\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n },\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetDatasetVersion' => [
'summary' => '获取给定数据集版本信息',
'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' => '数据集版本ID', 'type' => 'string', 'required' => true, 'example' => ' '."\n"
.'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n"
.':2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'DatasetVersion' => ['title' => '数据集版本', 'description' => '数据集版本', '$ref' => '#/components/schemas/DatasetVersion'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据集版本信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true,\\n \\"DatasetVersion\\": {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n }\\n}","type":"json"}]',
],
'GetDeploymentPackage' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '269309',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n"
."\n\n"
.'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'DeploymentId',
'in' => 'formData',
'schema' => ['description' => '发布包的ID。'."\n"
.'执行[SubmitFile](~~173944~~) 和[DeployFile](~~173956~~)时，都会生成一个对应的发布包ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000001'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP 状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'You have no permission.'],
'RequestId' => ['description' => '请求ID。用于定位日志，排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0bc1ec92159376****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '发布包的详情'."\n"
.'。',
'type' => 'object',
'properties' => [
'Deployment' => [
'description' => '发布包的详'."\n"
.'情。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '发布包当前的状态'."\n"
.'，包括0（就绪）、1（成功）和2（失败）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ErrorMessage' => ['description' => '当发布包执行失败（status为2）后，'."\n"
.'该字段记录具体的错误信息。', 'type' => 'string', 'example' => 'Success'],
'FromEnvironment' => ['description' => '执行本次发布所在的环境'."\n"
.'，包括0（本地）和1（开发环境）。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ToEnvironment' => ['description' => '发布文件信息的目标环境，'."\n"
.'包括1（开发环境）和2（生产环境）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CheckingStatus' => ['description' => '当前发布包涉及节点的检查状态，'."\n"
.'当发布包的目标环境是开发环境（toEnviroment=1）时，只有发布包的Status为1并且CheckingStatus为空时，才可以继续进行文件到生产环境的发布。'."\n"
.'- 7：检查未通过'."\n"
.'- 8：正在处于检查中的状态', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'CreateTime' => ['description' => '发布包生成的毫秒时间'."\n"
.'戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000'],
'HandlerId' => ['description' => '发布包执行者的阿里云用'."\n"
.'户ID。', 'type' => 'string', 'example' => '2003****'],
'CreatorId' => ['description' => '发布包创建者的阿里云'."\n"
.'用户ID。', 'type' => 'string', 'example' => '20030****'],
'ExecuteTime' => ['description' => '发布包开始执行的毫秒时'."\n"
.'间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000'],
'Name' => ['description' => '发布包的名称，'."\n"
.'显示在任务发布>发布包列表页面。', 'type' => 'string', 'example' => 'ods_user_info_d-2020-07-04_20030****'],
],
],
'DeployedItems' => [
'description' => '发布项详情。',
'type' => 'array',
'items' => [
'description' => '发布项详情。',
'type' => 'object',
'properties' => [
'FileId' => ['description' => '文件的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '5076****'],
'FileVersion' => ['description' => '文件的版本'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'Status' => ['description' => '* UNPUBLISHED(0): 未发布'."\n"
."\n"
.'* SUCCESS(1): 发布成功'."\n"
.'* ERROR(2): 发布失败'."\n"
.'* CLONED(3): 克隆成功'."\n"
.'* DEPLOY_ERROR(4): 发布失败'."\n"
.'* CLONING(5): 克隆中'."\n"
.'* REJECT(6): 发布驳回', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"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' => '获取发布包的详情',
'summary' => '调用GetDeploymentPackage获取发布包的详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n"
."\n"
.'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => ['description' => '文件的ID。您可以调用[ListFiles](~~173942~~)接口查询对应文件的ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000001'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '调度节点的ID。您可以调用[ListFiles](~~173942~~)接口获取节点ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200000001'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '文件的详情。',
'type' => 'object',
'properties' => [
'File' => [
'description' => '文件的基本信息。',
'type' => 'object',
'properties' => [
'CommitStatus' => ['description' => '文件当前的提交状态，包括0（未提交最新的代码）和1（已提交最新的代码）。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AutoParsing' => ['description' => '文件是否开启自动解析功能。取值如下：'."\n"
.'- true：文件会自动解析代码。'."\n"
.'- false：文件不会自动解析代码。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', 'type' => 'boolean', 'example' => 'true'],
'Owner' => ['description' => '文件责任人的阿里云用户ID。', 'type' => 'string', 'example' => '7775674356****'],
'CreateTime' => ['description' => '文件创建的时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000'],
'FileType' => ['description' => '文件的代码类型。文件类型，不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'CurrentVersion' => ['description' => '文件当前已经提交的最新版本号。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'BizId' => ['description' => '文件所属业务流程的ID。该字段已废弃，请使用BusinessId字段。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001'],
'LastEditUser' => ['description' => '最近一次编辑文件的阿里云用户ID。', 'type' => 'string', 'example' => '424732****'."\n"],
'FileName' => ['description' => '文件的名称。', 'type' => 'string', 'example' => 'ods_user_info_d'],
'ConnectionName' => ['description' => '执行文件对应的任务时，所使用的数据源名称。', 'type' => 'string', 'example' => 'odps_source'],
'UseType' => ['description' => '文件所属的功能模块。取值如下：'."\n"
.'- NORMAL：数据开发。'."\n"
.'- MANUAL：手动任务。'."\n"
.'- MANUAL_BIZ：手动业务流程。'."\n"
.'- SKIP：数据开发的空跑调度。'."\n"
.'- ADHOCQUERY：临时查询。'."\n"
.'- COMPONENT：组件管理。'."\n", 'type' => 'string', 'example' => 'NORMAL'],
'FileFolderId' => ['description' => '文件所属文件夹的ID。', 'type' => 'string', 'example' => '2735c2****'],
'ParentId' => ['description' => '如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'],
'CreateUser' => ['description' => '文件创建人的阿里云用户ID。', 'type' => 'string', 'example' => '424732****'."\n"],
'IsMaxCompute' => ['description' => '标识该资源文件是否需要上传至MaxCompute。'."\n"
.'仅当文件是MaxCompute资源文件时才需要配置该参数。', 'type' => 'boolean', 'example' => 'true'],
'BusinessId' => ['description' => '文件的业务流程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001'],
'FileDescription' => ['description' => '文件的描述信息。', 'type' => 'string', 'example' => 'My first DataWorks file'],
'DeletedStatus' => ['description' => '文件的删除状态。取值如下：'."\n"
.'- NORMAL：未删除。'."\n"
.'- RECYCLE_BIN：回收站。'."\n"
.'- DELETED：被删除。', 'type' => 'string', 'example' => 'RECYCLE'],
'LastEditTime' => ['description' => '最近一次编辑文件的时间戳，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000'],
'Content' => ['description' => '文件的代码。', 'type' => 'string', 'example' => 'SHOW TABLES;'],
'NodeId' => ['description' => '提交文件后，在调度系统生成的调度任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '300001'],
'AdvancedSettings' => ['description' => '任务的高级配置。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR数据开发任务，编辑页面右侧导航栏的“高级设置“对应。'."\n"
."\n"
.'> 当前EMR Shell任务不支持配置高级参数。'."\n"
."\n"
.'各EMR任务开发的高级参数说明，请参见[EMR任务开发](~~473077~~)。', 'type' => 'string', 'example' => '{\\"priority\\":\\"1\\",\\"ENABLE_SPARKSQL_JDBC\\":false,\\"FLOW_SKIP_SQL_ANALYZE\\":false,\\"queue\\":\\"default\\"}'],
'FileId' => ['description' => '文件的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000001'],
],
],
'NodeConfiguration' => [
'description' => '文件的调度配置。',
'type' => 'object',
'properties' => [
'RerunMode' => ['description' => '重跑属性。取值如下：'."\n"
.'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n"
.'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n"
.'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', 'type' => 'string', 'example' => 'ALL_ALLOWED'],
'SchedulerType' => ['description' => '调度的类型，取值如下：'."\n"
.'- NORMAL：正常调度任务。'."\n"
.'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n"
.'- PAUSE：暂停任务。'."\n"
.'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', 'type' => 'string', 'example' => 'NORMAL'],
'Stop' => ['description' => '是否暂停调度，取值如下：'."\n"
.'- true：暂停调度。'."\n"
.'- false：不暂停调度。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为”暂停调度“时对应。', 'type' => 'boolean', 'example' => 'false'],
'ParaValue' => ['description' => '调度参数。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', 'type' => 'string', 'example' => 'a=x b=y'],
'StartEffectDate' => ['description' => '开始自动调度的毫秒时间戳。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', 'type' => 'integer', 'format' => 'int64', 'example' => '936923400000'],
'EndEffectDate' => ['description' => '停止自动调度的时间戳，单位为毫秒。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', 'type' => 'integer', 'format' => 'int64', 'example' => '4155787800000'],
'CycleType' => ['description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', 'type' => 'string', 'example' => 'DAY'],
'DependentNodeIdList' => ['description' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“上一周期”后，依赖项选择”其他节点“时配置的内容对应。', 'type' => 'string', 'example' => '5,10,15,20'],
'ResourceGroupId' => ['description' => '文件发布成任务后，任务执行时对应的资源组。您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '375827434852437'],
'DependentType' => ['description' => '依赖上一周期的方式。取值如下：'."\n"
.'- SELF：依赖项选择本节点。'."\n"
.'- CHILD：依赖项选择一级子节点。'."\n"
.'- USER_DEFINE：依赖项选择其他节点。'."\n"
.'- NONE：未选择依赖项，即不会依赖上一周期。', 'type' => 'string', 'example' => 'USER_DEFINE'],
'AutoRerunTimes' => ['description' => '出错自动重跑的次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'AutoRerunIntervalMillis' => ['description' => '出错自动重跑时间间隔，单位为毫秒。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>出错自动重跑”的”重跑间隔“配置对应。'."\n"
.'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '120000'],
'CronExpress' => ['description' => '文件定时调度的cron表达式。', 'type' => 'string', 'example' => '00 05 00 * * ?'],
'InputList' => [
'description' => '依赖的上游文件输出信息。',
'type' => 'array',
'items' => [
'description' => '依赖的上游文件输出信息。',
'type' => 'object',
'properties' => [
'Input' => ['description' => '文件依赖的上游文件的输出名称。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的”父节点输出名称”对应。', 'type' => 'string', 'example' => 'project.001_out'],
'ParseType' => ['description' => '配置文件依赖的方式，取值如下：'."\n"
.'- MANUAL：手动配置。'."\n"
.'- AUTO：自动解析。', 'type' => 'string', 'example' => 'MANUAL'],
],
],
],
'OutputList' => [
'description' => '文件的输出信息。',
'type' => 'array',
'items' => [
'description' => '文件的输出信息。',
'type' => 'object',
'properties' => [
'RefTableName' => ['description' => '文件的输出值。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出表”列的值对应。', 'type' => 'string', 'example' => 'ods_user_info_d'],
'Output' => ['description' => '文件的输出名称。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖“选择”同周期“时的“本节点的输出名称”列值对应。', 'type' => 'string', 'example' => 'dw_project.002_out'],
],
],
],
'StartImmediately' => ['description' => '发布后是否立即启动。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。', 'type' => 'boolean', 'example' => 'true'],
'InputParameters' => [
'description' => '返回结果。',
'type' => 'array',
'items' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'ParameterName' => ['description' => '节点上下文输入参数的参数名称。在代码中可以使用${...}方式引用该参数。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”参数名“对应。', 'type' => 'string', 'example' => 'input'],
'ValueSource' => ['description' => '节点上下文输入参数的取值来源。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输入参数“的”取值来源“对应。', 'type' => 'string', 'example' => 'project_001.parent_node:outputs'],
],
],
],
'OutputParameters' => [
'description' => '返回结果。',
'type' => 'array',
'items' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'ParameterName' => ['description' => '节点上下文输出参数的参数名称。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”参数名“对应。', 'type' => 'string', 'example' => 'output'],
'Value' => ['description' => '节点上下文输出参数的表达式。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”取值“对应。', 'type' => 'string', 'example' => '${bizdate}'],
'Type' => ['description' => '节点上下文输出参数表达式的类型。取值如下：'."\n"
.'- 1：表示常量。'."\n"
.'- 2：表示变量。'."\n"
.'- 3：表示参数节点透传变量。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文>本节点输出参数“的”类型“对应。', 'type' => 'string', 'example' => '1'],
'Description' => ['description' => '节点上下文输出的参数描述。', 'type' => 'string', 'example' => 'It\'s a context output parameter.'],
],
],
],
'ApplyScheduleImmediately' => ['description' => '是否发布后立即生效调度配置', 'type' => 'string', 'example' => 'true'],
'IgnoreParentSkipRunningProperty' => ['description' => '调度配置->上一周期->是否跳过上游的空跑属性', 'type' => 'string', 'example' => 'true'],
'Timeout' => ['description' => '调度配置超时定义', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ImageId' => ['description' => '自定义镜像ID', 'type' => 'string', 'example' => 'm-bp1h4b5a8ogkbll2f3tr'],
],
],
'ResourceDownloadLink' => [
'description' => '资源下载地址',
'type' => 'object',
'properties' => [
'downloadLink' => ['description' => '资源下载地址链接', 'type' => 'string', 'example' => 'http://xx'],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'title' => '获取文件的详情',
'summary' => '该接口用于获取文件的详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '文件的ID，您可以通过[ListFiles](~~173942~~)查询对应文件的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000001'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID，您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1000011'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n"
."\n"
.'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FileVersion',
'in' => 'formData',
'schema' => ['description' => '需要查询的文件版本。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。'."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '文件的版本详情。',
'type' => 'object',
'properties' => [
'FileContent' => ['description' => '生成本次文件版本的文件代码。', 'type' => 'string', 'example' => 'SHOW TABLES;'],
'IsCurrentProd' => ['description' => '本次文件版本是否为当前生产环境的最新版本。'."\n"
.'- true：是最新版本。'."\n"
.'- false：不是最新版本。', 'type' => 'boolean', 'example' => 'true'],
'Status' => ['description' => '文件版本当前的状态，取值如下：'."\n"
.'- COMMITTING（提交中）'."\n"
.'- COMMITTED或CHECK_OK（已提交）'."\n"
.'- PACKAGED（准备发布）'."\n"
.'- DEPLOYING（发布中）'."\n"
.'- DEPLOYED（已发布）'."\n"
.'- CANCELLED（取消发布）', 'type' => 'string', 'example' => 'COMMITTED'],
'NodeContent' => ['description' => '本次文件版本生成时的调度配置。', 'type' => 'string', 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}'],
'CommitUser' => ['description' => '生成本次文件版本的阿里云用户ID。', 'type' => 'string', 'example' => ' '."\n"
.'7384234****'."\n"],
'Comment' => ['description' => '本次文件版本的说明。', 'type' => 'string', 'example' => 'Second version submission'],
'FilePropertyContent' => ['description' => '生成本次文件版本的文件基本信息。', 'type' => 'string', 'example' => '{"fileName":"ods_user_info_d","fileType":10}'],
'FileName' => ['description' => '生成本次文件版本的文件名。', 'type' => 'string', 'example' => 'ods_user_info_d'],
'UseType' => ['description' => '文件所属的功能模块，取值如下：'."\n"
.'- 0：NORMAL（数据开发）'."\n"
.'- 1：MANUAL（手动任务）'."\n"
.'- 2：MANUAL_BIZ（手动工作流）'."\n"
.'- 3：SKIP（数据开发的空跑调度）'."\n"
.'- 10：ADHOCQUERY（临时查询）'."\n"
.'- 30：COMPONENT（组件管理）'."\n", 'type' => 'string', 'example' => '0'],
'ChangeType' => ['description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE。', 'type' => 'string', 'example' => 'UPDATE'],
'FileVersion' => ['description' => '文件的版本。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'CommitTime' => ['description' => '文件版本生成的毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593881265000'],
'NodeId' => ['description' => '文件版本生成时对应的调度任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001'],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'title' => '获取文件的版本详情',
'summary' => '调用GetFileVersion获取文件的版本详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1000011'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FolderId',
'in' => 'formData',
'schema' => ['description' => '文件夹的ID，该参数与FolderPath参数，二者必须设置其一。'."\n"
.'您可以调用[ListFolders](~~173955~~)接口获取文件夹ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '273****'],
],
[
'name' => 'FolderPath',
'in' => 'formData',
'schema' => ['description' => '文件夹的路径，该参数与FolderId参数，二者必须设置其一。'."\n"
.'您可以调用[ListFolders](~~173955~~)接口获取文件夹路径。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', 'minLength' => 1],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。'."\n"
.'用于出现错误后排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- **true**：调用成功。'."\n"
.'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '文件夹的详情'."\n"
.'。',
'type' => 'object',
'properties' => [
'FolderPath' => ['description' => '文件夹的路径'."\n"
.'。', 'type' => 'string', 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer'],
'FolderId' => ['description' => '文件夹的ID'."\n"
.'。', 'type' => 'string', 'example' => '2735****'],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\",\\n \\"FolderId\\": \\"2735****\\"\\n }\\n}","type":"json"}]',
'title' => '获取文件夹的详情',
'summary' => '调用GetFolder获取文件夹的详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetFunction' => [
'summary' => '获取指定数据开发udf函数的详细信息。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => 'UDF函数的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '86043887262011****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID，用于后续错误排查使用。', 'type' => 'string', 'example' => '6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX'],
'Function' => [
'description' => 'udf函数详细信息',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => 'udf函数所属的DataWorks工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'Name' => ['description' => 'udf函数的名称', 'type' => 'string', 'example' => 'Function name'],
'Owner' => ['description' => 'udf函数的责任人', 'type' => 'string', 'example' => '110755000425XXXX'],
'CreateTime' => ['description' => 'udf函数的创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1724505917000'],
'ModifyTime' => ['description' => 'udf函数的最近修改时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1724506661000'],
'Spec' => ['description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', 'type' => 'string', 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "Function",'."\n"
.' "spec": {'."\n"
.' "functions": ['."\n"
.' {'."\n"
.' "name": "Function_Name",'."\n"
.' "id": "580667964888595XXXX",'."\n"
.' "script": {'."\n"
.' "content": "{ \\"uuid\\": \\"580667964888595XXXX\\", \\"name\\": \\"Function_Name\\", \\"datasource\\": { \\"type\\": \\"odps\\", \\"name\\": \\"odps_first\\" }, \\"runtimeResource\\": { \\"resourceGroup\\": \\"S_res_group_XXXX_XXXX\\", \\"resourceGroupId\\": 6591XXXX }}",'."\n"
.' "path": "XXX/OpenAPI/Function/Function_Name",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_FUNCTION"'."\n"
.' }'."\n"
.' },'."\n"
.' "datasource": {'."\n"
.' "name": "odps_first",'."\n"
.' "type": "odps"'."\n"
.' },'."\n"
.' "runtimeResource": {'."\n"
.' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n"
.' "id": "723932906364267XXXX",'."\n"
.' "resourceGroupId": "6591XXXX"'."\n"
.' },'."\n"
.' "metadata": {'."\n"
.' "owner": "110755000425XXXX"'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
'Id' => ['description' => 'udf函数唯一标识。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', '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' => '获取数据开发函数详情',
'changeSet' => [
['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetIDEEventDetail' => [
'summary' => '根据DataWorks开放消息的消息ID，查询触发扩展点事件时的扩展点数据快照。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '269311',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
],
'parameters' => [
[
'name' => 'MessageId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n"
."\n"
.'消息格式，可参考[消息格式](~~215367~~)。'."\n", 'type' => 'string', 'required' => true, 'example' => '8abcb91f-d266-4073-b907-2ed67****1'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID，您可以通过解析DataWorks开放消息获取空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的唯一标识，用于后续错误排查使用。', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'],
'EventDetail' => [
'description' => '触发扩展点事件时的数据快照。'."\n"
."\n"
.'不同类型的消息事件，数据快照的有效字段存在差异，具体请参考各消息事件的字段说明。',
'type' => 'object',
'properties' => [
'FileExecutionCommand' => [
'description' => '文件代码执行时的快照，当Message类型为IDE_FILE_EXECUTE_BEFORE时有效。',
'type' => 'object',
'properties' => [
'FileId' => ['description' => '文件的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234123'],
'DataSourceName' => ['description' => '文件关联的数据源唯一标识。', 'type' => 'string', 'example' => 'odps_source'],
'Content' => ['description' => '生成本次文件版本的文件代码。', 'type' => 'string', 'example' => 'SHOW TABLES;'],
'FileType' => ['description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
'DeletedFile' => [
'description' => '删除文件时的快照信息，当Message类型为IDE_FILE_DELETE_BEFORE时有效。',
'type' => 'object',
'properties' => [
'Owner' => ['description' => '文件责任人。', 'type' => 'string', 'example' => '7384234****'],
'FileType' => ['description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'CurrentVersion' => ['description' => '当前文件的最新版本。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'BusinessId' => ['description' => '文件所属的业务流程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '74328'],
'FileName' => ['description' => '文件名称。', 'type' => 'string', 'example' => 'hello_dataworks.sql'],
'DataSourceName' => ['description' => '文件关联的数据源唯一标识。', 'type' => 'string', 'example' => 'odps_source'],
'UseType' => ['description' => '文件所属的功能模块。取值如下：'."\n"
.'- NORMAL：数据开发'."\n"
.'- MANUAL：手动任务'."\n"
.'- MANUAL_BIZ：手动业务流程'."\n"
.'- SKIP：数据开发的空跑调度'."\n"
.'- ADHOCQUERY：临时查询'."\n"
.'- COMPONENT：组件管理', 'type' => 'string', 'example' => 'NORMAL'],
'FolderId' => ['description' => '文件所属的文件夹ID，您可以调用[GetFolder](~~173952~~)接口，通过文件夹ID查询文件详情。', 'type' => 'string', 'example' => 'aldurie78l2falure'],
'ParentFileId' => ['description' => '文件所属的循环节点或遍历节点的节点ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234122'],
'Content' => ['description' => '生成本次文件版本的文件代码。', 'type' => 'string', 'example' => 'SHOW TABLES;'],
'NodeId' => ['description' => '调度节点的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '421429'],
'FileId' => ['description' => '文件的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234123'],
],
],
'CommittedFile' => [
'description' => '文件提交和发布时的快照。'."\n"
."\n"
.'仅当Message类型为IDE_FILE_SUBMIT_BEFORE或IDE_FILE_DEPLOY_BEFORE时有效。',
'type' => 'object',
'properties' => [
'FileId' => ['description' => '文件的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234123'],
'Content' => ['description' => '生成本次文件版本的文件代码。', 'type' => 'string', 'example' => 'SHOW TABLES;'],
'Committor' => ['description' => '生成本次文件版本的阿里云用户ID。', 'type' => 'string', 'example' => '7384234****'],
'FileType' => ['description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'ChangeType' => ['description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE。', 'type' => 'string', 'example' => 'UPDATE'],
'FileName' => ['description' => '文件名称。', 'type' => 'string', 'example' => 'hello_dataworks.sql'],
'NodeId' => ['description' => '调度节点的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '421429'],
'Comment' => ['description' => '本次文件版本的说明。', 'type' => 'string', 'example' => 'Second version submission'],
'UseType' => ['description' => '文件所属的功能模块。取值如下：'."\n"
.'- NORMAL：数据开发'."\n"
.'- MANUAL：手动任务'."\n"
.'- MANUAL_BIZ：手动业务流程'."\n"
.'- SKIP：数据开发的空跑调度'."\n"
.'- ADHOCQUERY：临时查询'."\n"
.'- COMPONENT：组件管理', 'type' => 'string', 'example' => 'NORMAL'],
'FilePropertyContent' => [
'description' => '文件的更多属性。',
'type' => 'object',
'properties' => [
'DataSourceName' => ['description' => '文件关联的数据源唯一标识。', 'type' => 'string', 'example' => 'odps_source'],
'ParentFileId' => ['description' => '文件所属的循环节点或遍历节点的节点ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234122'],
'BusinessId' => ['description' => '文件所属的业务流程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '74328'],
'CurrentVersion' => ['description' => '当前文件的最新版本。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Owner' => ['description' => '文件责任人。', 'type' => 'string', 'example' => '7384234****'],
'FolderId' => ['description' => '文件所属的文件夹ID，您可以调用[GetFolder](~~173952~~)接口，通过文件夹ID查询文件详情。', 'type' => 'string', 'example' => 'aldurie78l2falure'],
],
],
'NodeConfiguration' => [
'description' => '文件的调度属性配置。',
'type' => 'object',
'properties' => [
'RerunMode' => ['description' => '重跑属性。取值如下：'."\n"
.'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n"
.'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n"
.'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。', 'type' => 'string', 'example' => 'ALL_ALLOWED'],
'SchedulerType' => ['description' => '调度的类型，取值如下：'."\n"
.'- NORMAL：正常调度任务。'."\n"
.'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n"
.'- PAUSE：暂停任务。'."\n"
.'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。', 'type' => 'string', 'example' => 'NORMAL'],
'ParaValue' => ['description' => '调度参数。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>参数”对应。您可以参考[调度参数](~~137548~~)配置。', 'type' => 'string', 'example' => 'a=x b=y'],
'CycleType' => ['description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。', 'type' => 'string', 'example' => 'DAY'],
'DependentNodeIdList' => ['description' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>跨周期依赖（原上一周期）”，依赖项选择”其他节点“时配置的内容对应。', 'type' => 'string', 'example' => '5,10,15,20'],
'ResourceGroupId' => ['description' => '文件发布成任务后，任务执行时使用的资源组。您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '375827434852437'],
'AutoRerunTimes' => ['description' => '自动重跑次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'AutoRerunIntervalMillis' => ['description' => '自动重跑间隔毫秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '120000'],
'CronExpress' => ['description' => '调度Cron表达式。', 'type' => 'string', 'example' => '00 05 00 * * ?'],
'InputList' => [
'description' => '依赖的上游文件输出信息。',
'type' => 'array',
'items' => [
'description' => '依赖的上游文件输出信息。',
'type' => 'object',
'properties' => [
'Input' => ['description' => '文件依赖的上游文件的输出名称。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>依赖上游节点“的”上游节点输出名”对应。', 'type' => 'string', 'example' => 'dw_project_root'],
'ParseType' => ['description' => '配置文件依赖的方式，取值如下：'."\n"
.'- MANUAL：手动配置。'."\n"
.'- AUTO：自动解析。', 'type' => 'string', 'example' => 'MANUAL'],
],
],
],
'OutputList' => [
'description' => '文件的输出信息。',
'type' => 'array',
'items' => [
'description' => '文件的输出信息。',
'type' => 'object',
'properties' => [
'RefTableName' => ['description' => '文件的输出表名。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>本节点输出名称“的“输出表名”对应。', 'type' => 'string', 'example' => 'ods_user_info_d'],
'Output' => ['description' => '文件的输出名称。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖>本节点输出名称“的“输出名”对应。', 'type' => 'string', 'example' => 'dw_project.002_out'],
],
],
],
'DependentType' => ['description' => '依赖上一周期的方式。取值如下：'."\n"
.'- SELF：依赖项选择本节点。'."\n"
.'- CHILD：依赖项选择一级子节点。'."\n"
.'- USER_DEFINE：依赖项选择其他节点。'."\n"
.'- NONE：未选择依赖项，即不会依赖上一周期。'."\n", 'type' => 'string', 'example' => 'USER_DEFINE'],
],
],
],
],
'TableModel' => [
'description' => '表提交和发布时的快照，当Message类型为IDE_TABLE_SUBMIT_BEFORE和IDE_TABLE_DEPLOY_BEFORE时有效。',
'type' => 'object',
'properties' => [
'Env' => ['description' => '表所属环境。取值如下：'."\n"
.'- DEV：开发环境。'."\n"
.'- PROD：生产环境。', 'type' => 'string', 'example' => 'DEV'],
'LifeCycle' => ['description' => '表的生命周期。单位为天。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'TableName' => ['description' => '表名称。', 'type' => 'string', 'example' => 'tb_hello'],
'DataSourceName' => ['description' => '表所属数据源的唯一标识。', 'type' => 'string', 'example' => 'odps_source'],
'Columns' => [
'description' => '字段信息。',
'type' => 'array',
'items' => [
'description' => '字段信息。',
'type' => 'object',
'properties' => [
'ColumnName' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'ID'],
'ColumnType' => ['description' => '字段类型。', 'type' => 'string', 'example' => 'BIGINT'],
'IsPartitionColumn' => ['description' => '是否为分区字段，取值如下：'."\n"
.'- true：是分区字段。'."\n"
.'- false：非分区字段。', 'type' => 'boolean', 'example' => 'false'],
'Comment' => ['description' => '字段备注。', 'type' => 'string', 'example' => 'ID'],
],
],
],
'Comment' => ['description' => '表的备注信息。', 'type' => 'string', 'example' => 'A new table'],
'Location' => ['description' => '外部表的Location信息。', 'type' => 'string', 'example' => 'hdfs://path/to/object'],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\",\\n \\"EventDetail\\": {\\n \\"FileExecutionCommand\\": {\\n \\"FileId\\": 1234123,\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"FileType\\": 10\\n },\\n \\"DeletedFile\\": {\\n \\"Owner\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 1,\\n \\"BusinessId\\": 74328,\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\",\\n \\"ParentFileId\\": 1234122,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 421429,\\n \\"FileId\\": 1234123\\n },\\n \\"CommittedFile\\": {\\n \\"FileId\\": 1234123,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"Committor\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"NodeId\\": 421429,\\n \\"Comment\\": \\"Second version submission\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FilePropertyContent\\": {\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"ParentFileId\\": 1234122,\\n \\"BusinessId\\": 74328,\\n \\"CurrentVersion\\": 1,\\n \\"Owner\\": \\"7384234****\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\"\\n },\\n \\"NodeConfiguration\\": {\\n \\"RerunMode\\": \\"ALL_ALLOWED\\",\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"ParaValue\\": \\"a=x b=y\\",\\n \\"CycleType\\": \\"DAY\\",\\n \\"DependentNodeIdList\\": \\"5,10,15,20\\",\\n \\"ResourceGroupId\\": 375827434852437,\\n \\"AutoRerunTimes\\": 3,\\n \\"AutoRerunIntervalMillis\\": 120000,\\n \\"CronExpress\\": \\"00 05 00 * * ?\\",\\n \\"InputList\\": [\\n {\\n \\"Input\\": \\"dw_project_root\\",\\n \\"ParseType\\": \\"MANUAL\\"\\n }\\n ],\\n \\"OutputList\\": [\\n {\\n \\"RefTableName\\": \\"ods_user_info_d\\",\\n \\"Output\\": \\"dw_project.002_out\\"\\n }\\n ],\\n \\"DependentType\\": \\"USER_DEFINE\\"\\n }\\n },\\n \\"TableModel\\": {\\n \\"Env\\": \\"DEV\\",\\n \\"LifeCycle\\": 7,\\n \\"TableName\\": \\"tb_hello\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"ID\\",\\n \\"ColumnType\\": \\"BIGINT\\",\\n \\"IsPartitionColumn\\": false,\\n \\"Comment\\": \\"ID\\"\\n }\\n ],\\n \\"Comment\\": \\"A new table\\",\\n \\"Location\\": \\"hdfs://path/to/object\\"\\n }\\n }\\n}","type":"json"}]',
'title' => '查询触发扩展点事件时的数据快照',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetImage' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245169',
'abilityTreeNodes' => ['FEATUREdide2SV6DS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx'],
],
[
'name' => 'ImageVersion',
'in' => 'query',
'schema' => ['title' => '镜像版本，不填则获取最新版本', 'description' => '镜像版本，不填则获取最新版本', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true'],
'Image' => [
'title' => '镜像详情',
'description' => '镜像详情',
'type' => 'object',
'properties' => [
'Id' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'example' => 'Custom_image_xxxx_xxxx'],
'Name' => ['title' => '镜像名称', 'description' => '镜像名称', 'type' => 'string', 'example' => 'dataworks_image'],
'Version' => ['title' => '镜像版本', 'description' => '镜像版本', 'type' => 'string', 'example' => '1'],
'Description' => ['title' => '镜像描述', 'description' => '镜像描述', 'type' => 'string', 'example' => 'Test image created by xxx'],
'Creator' => ['title' => '创建人', 'description' => '创建人ID', 'type' => 'string', 'example' => '123'],
'Modifier' => ['title' => '修改人', 'description' => '修改人ID', 'type' => 'string', 'example' => '123'],
'CreatedTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'LastModifiedTime' => ['title' => '最后修改时间，为64位时间戳', 'description' => '最后修改时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'Official' => ['title' => '是否为官方镜像', 'description' => '是否为官方镜像', 'type' => 'boolean', 'example' => 'true'],
'Accessibility' => [
'title' => '可访问性',
'description' => '镜像可见性：'."\n"
.'- Public：全员可见；'."\n"
.'- Private：仅创建者可见。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Public',
'enum' => ['Tenant', 'Project', 'Public'],
],
'Status' => [
'title' => '镜像状态',
'description' => '镜像状态：'."\n"
.'- Disabled：禁用；'."\n"
.'- Expired：过期；'."\n"
.'- Available：可用；'."\n"
.'- ReadOnly：只读。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Available',
],
'PublishStage' => [
'title' => '发布阶段',
'description' => '发布状态：'."\n"
.'- Untest：未测试；'."\n"
.'- Testing：测试中；'."\n"
.'- TestFailed：测试失败；'."\n"
.'- Unpublished：未发布；'."\n"
.'- Publishing：发布中；'."\n"
.'- Published：已发布；'."\n"
.'- PublishFailed：发布失败；'."\n"
.'- Building：构建中；'."\n"
.'- BuildSuccess：构建成功；'."\n"
.'- BuildFailed：构建失败；'."\n"
.'- Accelerating：加速中；'."\n"
.'- AccelerateSuccess：加速成功；'."\n"
.'- AccelerateFailed：加速失败。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Published',
],
'Supported' => [
'title' => '支持的模块和任务类型',
'description' => '支持的模块和任务类型',
'type' => 'object',
'properties' => [
'Module' => ['title' => '支持的模块', 'description' => '支持的模块：'."\n"
.'- Scheduler：调度。', 'type' => 'string', 'example' => 'Scheduler'],
'TaskTypes' => [
'title' => '支持的任务类型列表',
'description' => '支持的任务类型列表',
'type' => 'array',
'items' => ['title' => '支持的任务类型', 'description' => '支持的任务类型：'."\n"
.'- Shell'."\n"
.'- Python'."\n"
.'- ServerIDE'."\n"
.'- Notebook'."\n"
.'- PyODPS 2'."\n"
.'- PyODPS 3', 'type' => 'string', 'example' => 'Shell'],
],
],
],
'IsDefault' => ['title' => '是否为默认镜像', 'description' => '是否为默认镜像', 'type' => 'boolean', 'example' => 'false'],
'EnableSyncMaxCompute' => ['title' => '是否启用同步MaxCompute', 'description' => '是否启用同步MaxCompute', 'type' => 'boolean', 'example' => 'false'],
'ProviderType' => ['title' => '提供者类型', 'description' => '镜像引用类型：'."\n"
."\n"
.'- ACR：ACR镜像仓库；'."\n"
.'- DataWorks：DataWorks官方镜像。', 'type' => 'string', 'example' => 'ACR'],
'ProviderImageId' => ['title' => '提供者镜像ID', 'description' => '镜像提供方镜像 ID', 'type' => 'string', 'example' => 'acr_image_id'],
'ImageUri' => ['title' => '镜像URI', 'description' => '镜像URI', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag'],
'Namespace' => ['title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'example' => 'namespace'],
'Size' => ['title' => '镜像大小', 'description' => '镜像大小', 'type' => 'string', 'example' => '1GB'],
'AcrInstanceId' => ['title' => 'ACR实例ID', 'description' => 'ACR实例ID', 'type' => 'string', 'example' => 'cri-xxx'],
'ImageTag' => ['title' => '镜像标签', 'description' => '镜像标签', 'type' => 'string', 'example' => 'v1.0.0'],
'RepositoryName' => ['title' => '仓库名称', 'description' => '仓库名称', 'type' => 'string', 'example' => 'repo_name'],
'ImageVpcUri' => ['title' => '镜像VPC URI', 'description' => '镜像VPC URI', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag'],
'AcrEndpoint' => ['title' => 'ACR端点', 'description' => 'ACR Endpoint', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com'],
'AcrAssociatedVpcId' => ['title' => 'ACR关联的VPC ID', 'description' => 'ACR 实例关联专有网络 ID', 'type' => 'string', 'example' => 'vpc-xxx'],
'BuildConfig' => [
'description' => '镜像构建配置',
'type' => 'object',
'properties' => [
'BuildType' => ['description' => '构建类型', 'type' => 'string', 'example' => 'PackageInstallation'],
'PackageInstallationScripts' => [
'description' => '预安装执行脚本列表',
'type' => 'array',
'items' => [
'description' => '预安装执行脚本',
'type' => 'object',
'properties' => [
'Type' => ['description' => '脚本类型', 'type' => 'string', 'example' => 'Python3'],
'Content' => ['description' => '脚本内容，若为安装包名称则以英文逗号分隔', 'type' => 'string', 'example' => 'requests'],
],
],
],
],
],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '根据ID获取指定镜像详情',
'summary' => '根据镜像ID获取指定镜像详情。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Image\\": {\\n \\"Id\\": \\"Custom_image_xxxx_xxxx\\",\\n \\"Name\\": \\"dataworks_image\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"Test image created by xxx\\",\\n \\"Creator\\": \\"123\\",\\n \\"Modifier\\": \\"123\\",\\n \\"CreatedTime\\": 1727055811000,\\n \\"LastModifiedTime\\": 1727055811000,\\n \\"Official\\": true,\\n \\"Accessibility\\": \\"Public\\",\\n \\"Status\\": \\"Available\\",\\n \\"PublishStage\\": \\"Published\\",\\n \\"Supported\\": {\\n \\"Module\\": \\"Scheduler\\",\\n \\"TaskTypes\\": [\\n \\"Shell\\"\\n ]\\n },\\n \\"IsDefault\\": false,\\n \\"EnableSyncMaxCompute\\": false,\\n \\"ProviderType\\": \\"ACR\\",\\n \\"ProviderImageId\\": \\"acr_image_id\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"Size\\": \\"1GB\\",\\n \\"AcrInstanceId\\": \\"cri-xxx\\",\\n \\"ImageTag\\": \\"v1.0.0\\",\\n \\"RepositoryName\\": \\"repo_name\\",\\n \\"ImageVpcUri\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"AcrEndpoint\\": \\"registry.cn-hangzhou.aliyuncs.com\\",\\n \\"AcrAssociatedVpcId\\": \\"vpc-xxx\\",\\n \\"BuildConfig\\": {\\n \\"BuildType\\": \\"PackageInstallation\\",\\n \\"PackageInstallationScripts\\": [\\n {\\n \\"Type\\": \\"Python3\\",\\n \\"Content\\": \\"requests\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'GetJobStatus' => [
'summary' => '返回异步任务的状态信息，调用异步化API后，通过轮训此API来获取成功状态。',
'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' => '调用异步API后返回的任务ID。', 'type' => 'string', 'required' => true, 'example' => '70ecdaec-bf21-4c11-8ecb-4f77453ceea8'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5E2BFE96-C0E0-5A98-85C8-633EC803198D'],
'JobStatus' => [
'description' => '任务状态实时结果。',
'type' => 'object',
'properties' => [
'JobId' => ['description' => '异步任务ID。', 'type' => 'string', 'example' => 'C664CDE3-9C0B-5792-B17F-6C543783BBBC'],
'JobType' => ['description' => '任务类型。'."\n"
."\n"
.'- **Create**：创建类任务。'."\n"
."\n"
.'- **Update**：更新类任务。'."\n"
."\n"
.'- **Cancel**：取消类任务。', 'type' => 'string', 'example' => 'Create'],
'Completed' => ['description' => '操作是否完成'."\n"
.'True：当前Job已经执行完成。 False：当前Job还在执行中。', 'type' => 'string', 'example' => 'False'],
'Status' => ['description' => '任务状态。取值：'."\n"
.'- **Success**：成功'."\n"
.'- **Fail**：失败'."\n"
.'- **Cancel**：取消'."\n"
.'- **Running**：执行中', 'type' => 'string', 'example' => 'Success'],
'Error' => ['description' => '任务失败信息', 'type' => 'string', 'example' => 'Not Found'],
'CreateTime' => ['description' => '创建时间。', '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' => '获取异步API运行状态',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetJobStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetLineageRelationship' => [
'summary' => '获取数据地图中给定的血缘关系详情信息。',
'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' => '血缘关系ID，参考ListLineageRelationships接口返回结果。', 'type' => 'string', 'required' => true, 'example' => '4as3dasf654a'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '58D5334A-B013-430E'],
'LineageRelationship' => ['description' => '血缘关系结构体。', '$ref' => '#/components/schemas/LineageRelationship'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"LineageRelationship\\": {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n}","type":"json"}]',
'title' => '获取数据地图血缘关系',
'description' => '1. 需要购买DataWorks标准版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetLineageRelationship',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetMcpServer' => [
'summary' => '读取 MCP Server 详情',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要读取的 MCP Server 名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'McpServer' => [
'description' => 'McpServer',
'type' => 'object',
'properties' => [
'CreatorId' => ['description' => '创建者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'ModifierId' => ['description' => '最近修改者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'Name' => ['description' => 'MCP Server 名称。'."\n", 'type' => 'string', 'example' => 'my-mcp-server'],
'Config' => [
'description' => 'MCP Server 连接配置。'."\n",
'type' => 'object',
'properties' => [
'Url' => ['description' => 'MCP Server 服务地址。'."\n", 'type' => 'string', 'example' => 'https://example.com/mcp/sse'],
'Transport' => ['description' => '传输协议。'."\n", 'type' => 'string', 'example' => 'SSE'],
'CustomHeaders' => ['description' => '自定义请求头。'."\n", 'type' => 'object', 'example' => '{}'],
],
],
'Visibility' => ['description' => '可见性级别。可选值：TENANT（账号内可见）、PROJECT（指定项目可见）、USER（指定用户可见）。', 'type' => 'string', 'example' => 'TENANT'],
'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'GmtModifiedTime' => ['description' => '最近修改时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '读取 MCP Server 详情',
'description' => '## 请求说明'."\n"
."\n"
.'该API用于通过指定MCP Server的名称来获取其详细的配置信息，包括但不限于创建者ID、最近修改者ID、服务地址、传输协议等。请求时必须提供MCP Server的确切名称作为参数。'."\n"
."\n"
.'### 注意事项'."\n"
.'- 确保您已获得相应的权限以调用此API。'."\n"
.'- MCP Server名称是区分大小写的，请确保输入正确。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"McpServer\\": {\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"Config\\": {\\n \\"Url\\": \\"https://example.com/mcp/sse\\",\\n \\"Transport\\": \\"SSE\\",\\n \\"CustomHeaders\\": {}\\n },\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]',
],
'GetMetaCollection' => [
'summary' => '获取数据地图给定集合的详细信息，支持查询数据地图类目和数据专辑两种类型。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '266716',
'abilityTreeNodes' => ['FEATUREdideE9XYA6'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '集合对象Id。', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****'],
'MetaCollection' => [
'description' => '集合信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '集合ID。', 'type' => 'string', 'example' => 'as78d756asd'],
'Type' => ['description' => '集合类型，可枚举，取值为'."\n"
."\n"
.' - Category 类目'."\n"
.' - Album 数据专辑'."\n"
.' - AlbumCategory 专辑子类目', 'type' => 'string', 'example' => 'Category'],
'ParentId' => ['description' => '父节点集合对象Id，可为空。', 'type' => 'string', 'example' => '4as3dasf654a'],
'Name' => ['description' => '集合对象名称。', 'type' => 'string', 'example' => 'test_category'],
'Description' => ['description' => '集合对象描述。', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['description' => '创建时间毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000'],
'ModifyTime' => ['description' => '修改时间毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000'],
'CreateUser' => ['description' => '创建者用户ID。', 'type' => 'string', 'example' => '456789'],
'Administrators' => [
'description' => '管理员用户ID列表，仅专辑类型支持，'."\n"
.'需要为同租户下用户，可设置多个。',
'type' => 'array',
'items' => ['description' => '管理员用户ID。', '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' => '获取数据地图集合信息',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetMetaEntity' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api:api_001'],
],
],
'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' => '0A04C673-BEFA-5803-94E5-89E2D9F8C567'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'MetaEntity' => ['title' => '自定义实体', 'description' => '自定义实体', '$ref' => '#/components/schemas/MetaEntity'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取元数据实体详情',
'summary' => '获取元数据实体详情，当前仅支持纯自定义类型',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A04C673-BEFA-5803-94E5-89E2D9F8C567\\",\\n \\"Success\\": true,\\n \\"MetaEntity\\": {\\n \\"Id\\": \\"custom_entity-customer_api:api_001\\",\\n \\"EntityType\\": \\"custom_entity-customer_api\\",\\n \\"Name\\": \\"api_001\\",\\n \\"Comment\\": \\"this is a comment\\",\\n \\"OwnerId\\": \\"207924799988354\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"MetaEntityDef\\": {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n },\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1763380628000,\\n \\"Attributes\\": {\\n \\"key\\": \\"v1\\"\\n }\\n }\\n}","type":"json"}]',
],
'GetMetaEntityDef' => [
'summary' => '获取自定义实体定义详情。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'EntityType',
'in' => 'formData',
'schema' => ['title' => '实体类型，需匹配 `^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$`', 'description' => '实体类型，需匹配 `^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$`', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api'],
],
],
'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' => 'C636A747-7E4E-594D-94CD-2B4F8A9A9A63'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'MetaEntityDef' => ['title' => '自定义实体定义', 'description' => '自定义实体定义', '$ref' => '#/components/schemas/MetaEntityDef'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取元数据实体定义',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B4F8A9A9A63\\",\\n \\"Success\\": true,\\n \\"MetaEntityDef\\": {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n }\\n}","type":"json"}]',
],
'GetNetwork' => [
'summary' => '获取某个网络资源详细信息。',
'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' => '网络资源ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'Network' => [
'title' => '获取到的网络资源详细信息',
'description' => '获取到的网络资源详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '网络资源ID', 'description' => '网络资源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'ResourceGroupId' => ['title' => '所属通用资源组的唯一标识', 'description' => '所属通用资源组的唯一标识。', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
'VpcId' => ['title' => '网络资源的VPC ID', 'description' => '网络资源的VPC ID。', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX'],
'VswitchId' => ['title' => '网络资源的交换机ID', 'description' => '网络资源的交换机ID。', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX'],
'SecurityGroupId' => ['title' => '网络资源的安全组ID', 'description' => '网络资源的安全组ID。', 'type' => 'string', 'example' => 'sg-2ze13vamugr7jenXXXXX'],
'Status' => [
'title' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除',
'description' => '当前网络资源状态：'."\n"
."\n"
.'- Pending代表等待；'."\n"
.'- Creating代表创建中；'."\n"
.'- Running代表正常运行中；'."\n"
.'- Deleting代表删除中；'."\n"
.'- Deleted代表已删除。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Running',
'enum' => ['Pending', 'Running', 'Deleting', 'Deleted', 'Creating'],
],
'CreateUser' => ['title' => '创建该网络资源的用户ID', 'description' => '创建该网络资源的用户ID。', 'type' => 'string', 'example' => '11075500042XXXXX'],
'CreateTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', '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' => '获取某个网络资源详细信息',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetNode' => [
'summary' => '获取指定的数据开发节点详细信息。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '86043887262011****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的id，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Node' => [
'description' => '数据开发节点详细信息',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => '工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'Name' => ['description' => '数据开发节点名称', 'type' => 'string', 'example' => 'Node name'],
'Owner' => ['description' => '数据开发节点责任人', 'type' => 'string', 'example' => '196596664824XXXX'],
'CreateTime' => ['description' => '创建数据开发节点时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000'],
'ModifyTime' => ['description' => '最近修改数据开发节点时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000'],
'Spec' => ['description' => '描述这个节点的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。', 'type' => 'string', 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "Node",'."\n"
.' "spec": {'."\n"
.' "nodes": ['."\n"
.' {'."\n"
.' "recurrence": "Normal",'."\n"
.' "id": "860438872620113XXXX",'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "datasource": {'."\n"
.' "name": "odps_test",'."\n"
.' "type": "odps"'."\n"
.' },'."\n"
.' "script": {'."\n"
.' "language": "odps-sql",'."\n"
.' "path": "XX/OpenAPI_Test/ODPS_SQL_Test",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_SQL",'."\n"
.' "commandTypeId": 10'."\n"
.' },'."\n"
.' "content": "select now();",'."\n"
.' "id": "853573334108680XXXX"'."\n"
.' },'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "id": "543680677872062XXXX",'."\n"
.' "cron": "00 00 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "runtimeResource": {'."\n"
.' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n"
.' "id": "623731286945488XXXX",'."\n"
.' "resourceGroupId": "7201XXXX"'."\n"
.' },'."\n"
.' "name": "ODPS_SQL_Test",'."\n"
.' "owner": "110755000425XXXX",'."\n"
.' "metadata": {'."\n"
.' "owner": "110755000425XXXX",'."\n"
.' "ownerName": "XXXXX@test.XXX.com",'."\n"
.' "projectId": "307XXX"'."\n"
.' },'."\n"
.' "inputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "lwttest_standard_root",'."\n"
.' "artifactType": "NodeOutput"'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "860438872620113XXXX",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "ODPS_SQL_Test",'."\n"
.' "isDefault": true'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ],'."\n"
.' "flow": ['."\n"
.' {'."\n"
.' "nodeId": "860438872620113XXXX",'."\n"
.' "depends": ['."\n"
.' {'."\n"
.' "type": "Normal",'."\n"
.' "output": "lwttest_standard_root"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "metadata": {'."\n"
.' "uuid": "860438872620113XXXX"'."\n"
.' }'."\n"
.'}'],
'TaskId' => ['description' => '节点发布后对应的调度任务Id', 'type' => 'integer', 'format' => 'int64', 'example' => '700006680527'],
'Id' => ['description' => '数据开发节点唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', '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' => '获取数据开发节点详情',
'changeSet' => [
['createdAt' => '2025-02-18T01:56:57.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetParameter' => [
'summary' => '根据参数ID获取参数的详细信息。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Parameter' => [
'title' => '返回数据',
'description' => '参数的详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '参数ID', 'description' => '参数ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'workspace.para'],
'Type' => ['title' => '参数类型', 'description' => '类型。'."\n"
.'- PlainConstant 常量（明文）'."\n"
.'- SecretConstant 常量（密文）'."\n"
.'- Variable 变量', 'type' => 'string', 'example' => 'PlainConstant'],
'Scope' => ['title' => '参数范围', 'description' => '参数范围', 'type' => 'string', 'example' => 'Project'],
'ProjectId' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'Version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Description' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'This is a test parameter.'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000'],
'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000'],
'Owner' => ['title' => '责任人', 'description' => '责任人', 'type' => 'string', 'example' => '123456789'],
'CreateUser' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => '123456789'],
'ModifyUser' => ['title' => '修改人', 'description' => '修改人', 'type' => 'string', 'example' => '123456789'],
'Properties' => [
'title' => '参数值配置',
'description' => '参数值配置',
'type' => 'array',
'items' => [
'title' => '参数值配置列表',
'description' => '参数值配置列表',
'type' => 'object',
'properties' => [
'EnvType' => ['title' => '环境类型', 'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'example' => 'value123'],
],
],
],
],
],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取指定参数',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Parameter\\": {\\n \\"Id\\": 12345,\\n \\"Name\\": \\"workspace.para\\",\\n \\"Type\\": \\"PlainConstant\\",\\n \\"Scope\\": \\"Project\\",\\n \\"ProjectId\\": 1000,\\n \\"Version\\": 1,\\n \\"Description\\": \\"This is a test parameter.\\",\\n \\"CreateTime\\": 1640000000000,\\n \\"ModifyTime\\": 1640000000000,\\n \\"Owner\\": \\"123456789\\",\\n \\"CreateUser\\": \\"123456789\\",\\n \\"ModifyUser\\": \\"123456789\\",\\n \\"Properties\\": [\\n {\\n \\"EnvType\\": \\"Prod\\",\\n \\"Value\\": \\"value123\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'GetPartition' => [
'summary' => '获取数据地图数据表的分区详情，当前仅支持MaxCompute和hms（EMR集群）类型。',
'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' => '数据表ID，可参考ListTables接口返回结果，'."\n"
.'以及[元数据实体相关概念说明](~~2880092~~)。', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '分区名称', 'description' => '分区名称'."\n"
.'。', 'type' => 'string', 'required' => true, 'example' => 'ds=20250101'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求'."\n"
.'ID。', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功'."\n"
.'。', 'type' => 'boolean', 'example' => 'true'],
'Partition' => ['description' => '分区详情'."\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' => '获取数据地图数据表的分区详情',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 目前只支持 MaxCompute、hms（EMR集群） 类型的表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetPipelineRun' => [
'summary' => '调用此接口，获取发布流程详细信息。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '实例 ID。', 'description' => '发布流程的唯一标识符。', 'type' => 'string', 'required' => true, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f****'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '08468352-032C-5262-AEDC-68C9FA05XXXX'],
'Pipeline' => [
'description' => '整个发布流程的信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '发布流程Id', 'description' => '发布流程Id', 'type' => 'string', 'deprecated' => false, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", 'pattern' => '', 'default' => ''],
'ProjectId' => ['description' => 'DataWorks工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '56160'],
'CreateTime' => ['title' => '发布包创建时间戳', 'description' => '发布包创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1724984066000'],
'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1724984066000', 'pattern' => '', 'default' => ''],
'Creator' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'deprecated' => false, 'example' => '137946317766XXXX', 'pattern' => '', 'default' => ''],
'Status' => [
'title' => '发布流程状态',
'description' => '发布流程状态'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Init 初始化'."\n"
.'- Running 运行中'."\n"
.'- Success 运行成功'."\n"
.'- Fail 运行失败'."\n"
.'- Termination 被终止'."\n"
.'- Cancel 被取消',
'type' => 'string',
'deprecated' => false,
'example' => 'Running',
'pattern' => '',
'default' => '',
'enum' => ['Init', 'Running', 'Success', 'Fail', 'Termination', 'Cancel'],
],
'Message' => ['description' => '发布失败的错误信息', 'type' => 'string', 'example' => 'Error message'],
'Stages' => [
'title' => '步骤详情',
'description' => '步骤详情',
'type' => 'array',
'items' => [
'title' => 'stage的元素',
'description' => 'stage的元素',
'type' => 'object',
'properties' => [
'Code' => ['title' => '阶段代号', 'description' => '发布阶段代号', 'type' => 'string', 'deprecated' => false, 'example' => 'DEV_CHECK', 'pattern' => '', 'default' => ''],
'Step' => ['title' => '步骤', 'description' => '发布阶段步骤编号', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '1', 'pattern' => '', 'default' => ''],
'Type' => [
'title' => '阶段类型',
'description' => '发布阶段类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Deploy 发布操作'."\n"
.'- Check 检查操作'."\n"
.'- Offline 下线操作'."\n"
.'- Build 构建操作'."\n"
.'- Delete 删除操作',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => ['Delete' => 'Delete', 'Build' => 'Build', 'Check' => 'Check', 'Offline' => 'Offline', 'Deploy' => 'Deploy'],
'example' => 'Check',
'pattern' => '',
'default' => '',
],
'Name' => ['title' => '阶段名称', 'description' => '阶段名称', 'type' => 'string', 'deprecated' => false, 'example' => 'Publish package build', 'pattern' => '', 'default' => ''],
'Description' => ['title' => '阶段描述', 'description' => '阶段描述', 'type' => 'string', 'deprecated' => false, 'example' => 'Phase description', 'pattern' => '', 'default' => ''],
'Message' => ['title' => '阶段信息', 'description' => '发布阶段异常信息', 'type' => 'string', 'deprecated' => false, 'example' => 'Exception information XXX', 'pattern' => '', 'default' => ''],
'Status' => [
'title' => '阶段状态',
'description' => '发布阶段状态'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Init 初始化'."\n"
.'- Running 运行中'."\n"
.'- Success 运行成功'."\n"
.'- Fail 运行失败'."\n"
.'- Termination 被终止'."\n"
.'- Cancel 被取消',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => ['Init' => 'Init', 'Cancel' => 'Cancel', 'Running' => 'Running', 'Termination' => 'Termination', 'Success' => 'Success', 'Fail' => 'Fail'],
'example' => 'Running',
'pattern' => '',
'default' => '',
],
'Detail' => [
'description' => '阶段详细信息',
'type' => 'object',
'deprecated' => false,
'additionalProperties' => ['type' => 'any', 'description' => '阶段额外的信息描述', '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'],
'title' => '获取发布流程详细信息',
'description' => '>低版本的SDK中可能无该接口，此时请使用GetDeployment接口，参数与该文档一致。>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08468352-032C-5262-AEDC-68C9FA05XXXX\\",\\n \\"Pipeline\\": {\\n \\"Id\\": \\"a7ef0634-20ec-4a7c-a214-54020f91XXXX\\\\n\\",\\n \\"ProjectId\\": 56160,\\n \\"CreateTime\\": 1724984066000,\\n \\"ModifyTime\\": 1724984066000,\\n \\"Creator\\": \\"137946317766XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Publish package build\\",\\n \\"Description\\": \\"Phase description\\",\\n \\"Message\\": \\"Exception information XXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"\\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Build_Package_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Downstream_Dependency_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Decommissioning_Process_Checker\\\\\\"\\\\n }\\\\n]\\\\n\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"发布流程描述信息\\"\\n }\\n}","type":"json"}]',
],
'GetProcessDefinition' => [
'summary' => '根据给定的流程定义ID，获取对应的审批策略详细信息。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244495',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '流程定义ID'."\n", 'type' => 'string', 'required' => true, 'example' => 'f0d6d578-a305-40ac-ba1e-0a09f64cbc69'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
'ProcessDefinition' => [
'description' => '流程定义',
'type' => 'object',
'properties' => [
'Id' => ['description' => '流程定义 ID', 'type' => 'string', 'example' => '210001039767'],
'Name' => ['description' => '流程定义名称'."\n", 'type' => 'string', 'example' => 'MaxCompute 表审批'],
'Description' => ['description' => '业务流程的描述信息。', 'type' => 'string', 'example' => '订单业务数据审批流程'],
'Type' => ['description' => '流程定义类型，枚举：'."\n"
."\n"
.'- MaxCompute'."\n"
.'- DataService'."\n"
.'- Extension'."\n"
.'- Hologres'."\n"
.'- DlfV1 【不支持自定义新建】'."\n"
.'- Emr 【不支持自定义新建】'."\n"
.'- DataAssetGovernance【不支持自定义新建】'."\n"
.'- Lindorm【不支持自定义新建】'."\n"
.'- StarRocks【不支持自定义新建】'."\n"
.'- DlfNext【不支持自定义新建】'."\n"
.'- DataWorks【不支持自定义新建】', 'type' => 'string', 'example' => 'MaxCompute'],
'SubType' => ['description' => '子类型：'."\n"
.'- Table'."\n"
.'- Column'."\n"
.'- Database'."\n"
.'- Schema'."\n"
.'- Default', 'type' => 'string', 'example' => 'Table'],
'IsSystem' => ['description' => '是否为系统默认策略'."\n", 'type' => 'boolean', 'example' => 'false'],
'Enabled' => ['description' => '是否启用'."\n", 'type' => 'boolean', 'example' => 'true'],
'RuleConditions' => [
'description' => '审批策略生效规则列表'."\n",
'type' => 'array',
'items' => [
'description' => '审批策略生效规则',
'type' => 'object',
'properties' => [
'Type' => ['description' => '条件类型，枚举：'."\n"
."\n"
.'- `odpsProject`, '."\n"
.'- `hologresInstanceId`'."\n"
.'- `sensibleLevel`, '."\n"
.'- `tableGuid`, '."\n"
.'- `projectId`', 'type' => 'string', 'example' => 'odpsProject'],
'Expression' => ['description' => '条件表达式((#type==\'typeValue\')).如 ((#odpsProject==\'PX_BEIJING_TEST\'))', 'type' => 'string', 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))'],
'Scope' => ['description' => '规则生效阶段：'."\n"
.'- `Deployment` 用于判定"提交申请时是否匹配该审批策略'."\n"
.'- `Running` 用于审批流程执行判定是否免审批【仅支持MaxCompute类型】', 'type' => 'string', 'example' => 'Deployment'],
],
],
],
'NotificationServices' => [
'description' => '通知服务声明',
'type' => 'array',
'items' => [
'description' => '通知服务',
'type' => 'object',
'properties' => [
'Channel' => ['description' => '通知渠道，枚举：'."\n"
.'- Mail'."\n"
.'- Sms'."\n"
.'- DingRobot'."\n"
.'- Weixin'."\n", 'type' => 'string', 'example' => 'DingRobot'],
'Extension' => ['description' => '扩展信息，JSON 格式，如 `{"atAll":"true"}` 声明是否@所有人'."\n", 'type' => 'string', 'example' => '{"atAll":"true"}'],
'Receiver' => ['description' => 'Channel 为 DingRobot/Weixin 时需指定 WebhookUrl'."\n", 'type' => 'string', 'example' => 'https://dingtalk.com'],
],
],
],
'ApprovalNodes' => [
'description' => '审批节点列表',
'type' => 'array',
'items' => [
'description' => '审批节点',
'type' => 'object',
'properties' => [
'Id' => ['description' => '节点id'."\n", 'type' => 'string', 'example' => '7a809b6a-2a62-4c6c-9c23-c2a145e3877d'],
'Name' => ['description' => '**节点名称**'."\n", 'type' => 'string', 'example' => 'default-name'],
'AccountType' => ['description' => '**节点审批人类型**：'."\n"
.'- DataWorksProjectRole 空间角色'."\n"
.'- DataWorksProjectMember 空间成员'."\n"
.'- TableAdministrator 表负责人'."\n"
.'- TableOrProjectAdministrator 表或空间管理员'."\n"
.'- AliyunResourceOwner 阿里云账号'."\n"
.'- MaxComputeRole MC管理员'."\n"
.'- DLFAdmin DlfLegacy管理员'."\n"
.'- DLFNextAdmin DLFNext管理员'."\n"
.'- TenantRole 租户角色'."\n"
.'- EmrAdministrator Emr管理员'."\n"
.'- LindormAdministrator Lindorm管理员'."\n"
.'- AliyunRamUser RAM子账号'."\n", 'type' => 'string', 'example' => 'TableOrProjectAdministrator'],
'Assignees' => [
'description' => '**当 AccountType 为不同类型，对应不同语义**：'."\n"
.'- DataWorksProjectMember 声明空间成员 UserId'."\n"
.'- DataWorksProjectRole 声明空间角色 code'."\n"
.'- MaxComputeRole 声明 MC 的角色'."\n"
.'- TenantRole 声明租户角色 code'."\n"
.'- AliyunRamUser 声明 RAM userId'."\n",
'type' => 'array',
'items' => ['description' => '审批人', 'type' => 'string', 'example' => '213463068144525171'],
],
'ExtensionProperties' => [
'description' => '当 `AccountType ` 为不同类型，需要提供不同额外声明：'."\n"
."\n"
.'- DataWorksProjectMember： key 为 projectId, value 为空间成员 UserId，多个使用逗号分割'."\n"
.'- MaxComputeRole： key 为 MaxCompute 的 project, value 为 MC 中 role name，多个使用逗号分割',
'type' => 'object',
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "449656": "role_project_admin,role_project_pe"'."\n"
.' }', 'description' => '扩展说明'],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询审批流程定义详情',
'description' => '## 请求说明'."\n"
.'- 该API用于通过指定的`Id`参数来查询特定审批流程定义的所有相关信息。'."\n"
.'- `Id`是必填项，且必须是一个有效的流程定义ID。'."\n"
.'- 返回的信息包括但不限于流程定义的基本属性、规则条件、通知服务配置以及审批节点等。'."\n"
.'- 如果请求成功，将返回包含完整流程定义对象的数据；若失败，则会提供相应的错误代码和消息以帮助定位问题。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"ProcessDefinition\\": {\\n \\"Id\\": \\"210001039767\\",\\n \\"Name\\": \\"MaxCompute 表审批\\",\\n \\"Description\\": \\"订单业务数据审批流程\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"SubType\\": \\"Table\\",\\n \\"IsSystem\\": false,\\n \\"Enabled\\": true,\\n \\"RuleConditions\\": [\\n {\\n \\"Type\\": \\"odpsProject\\",\\n \\"Expression\\": \\"((#odpsProject==\'PX_BEIJING_TEST\'))\\",\\n \\"Scope\\": \\"Deployment\\"\\n }\\n ],\\n \\"NotificationServices\\": [\\n {\\n \\"Channel\\": \\"DingRobot\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"Receiver\\": \\"https://dingtalk.com\\"\\n }\\n ],\\n \\"ApprovalNodes\\": [\\n {\\n \\"Id\\": \\"7a809b6a-2a62-4c6c-9c23-c2a145e3877d\\",\\n \\"Name\\": \\"default-name\\",\\n \\"AccountType\\": \\"TableOrProjectAdministrator\\",\\n \\"Assignees\\": [\\n \\"213463068144525171\\"\\n ],\\n \\"ExtensionProperties\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"449656\\\\\\": \\\\\\"role_project_admin,role_project_pe\\\\\\"\\\\n }\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetProcessInstance' => [
'summary' => '获取指定审批流程实例的详细信息，包括审批节点和任务列表。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244495',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProcessInstanceId',
'in' => 'query',
'schema' => ['description' => '流程实例ID'."\n", 'type' => 'string', 'required' => true, 'example' => '332066440109224007'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
'ProcessInstance' => [
'description' => '审批流程实例详情'."\n",
'type' => 'object',
'properties' => [
'Id' => ['description' => '流程实例ID。', 'type' => 'string', 'example' => '332066440109224007'],
'Title' => ['description' => '流程实例名称', 'type' => 'string', 'example' => 'MaxCompute表权限申请'],
'Status' => [
'description' => '流程实例状态。取值如下：'."\n"
.'- Completed，已审批。'."\n"
.'- Running，审批中。'."\n"
.'- Aborted，已撤回。',
'type' => 'string',
'enumValueTitles' => ['running' => 'running', 'aborted' => 'aborted', 'completed' => 'completed'],
'example' => 'completed',
],
'Applicator' => ['description' => '申请人 UserId', 'type' => 'string', 'example' => '1107558004253538'],
'ApplicatorName' => ['description' => '申请人 阿里云账号名称。', 'type' => 'string', 'example' => 'test_account'],
'StartTime' => ['description' => '发起申请时间', 'type' => 'any', 'example' => '2026-05-25 10:20:18 CST'],
'Reason' => ['description' => '申请理由', 'type' => 'string', 'example' => '业务需要'],
'AuthErrorMessage' => ['description' => '授权失败信息。'."\n"
."\n"
.'注意：只有授权失败时才会存在。', 'type' => 'string', 'example' => 'S-400007:ODPS acl auth failed. odps table acl auth failed'],
'ApprovalTasks' => [
'description' => '审批任务列表',
'type' => 'array',
'items' => [
'description' => '审批任务',
'type' => 'object',
'properties' => [
'Id' => ['description' => '审批任务ID', 'type' => 'string', 'example' => 'task_001'],
'Status' => [
'description' => '任务状态：'."\n"
."\n"
.'- Completed： 完成'."\n"
.'- Pending： 待处理'."\n"
.'- Aborted： 已中止',
'type' => 'string',
'enumValueTitles' => ['Completed' => 'Completed', 'Pending' => 'Pending', 'Aborted' => 'Aborted'],
'example' => 'Aborted',
],
'ApprovalComment' => ['description' => '审批意见', 'type' => 'string', 'example' => '同意'],
'Assignee' => ['description' => '实际审批人UserId', 'type' => 'string', 'example' => '207947399706614297'],
'AssigneeName' => ['description' => '实际审批人名称', 'type' => 'string', 'example' => '李四'],
'ApprovalDecision' => [
'description' => '审批决策：'."\n"
."\n"
.'- Agree'."\n"
.'- Deny',
'type' => 'string',
'enumValueTitles' => ['deny' => 'deny', 'agree' => 'agree'],
'example' => 'Deny',
],
'CreateTime' => ['description' => '任务创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1715587200000'],
'CompleteTime' => ['description' => '任务结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1715590800000'],
'ApprovalNode' => [
'description' => '审批策略中审批节点',
'type' => 'object',
'properties' => [
'Id' => ['description' => '节点id', 'type' => 'string', 'example' => '7a809b6a-2a62-4c6c-9c23-c2a145e3877d'],
'Name' => ['description' => '节点名称', 'type' => 'string', 'example' => 'default-name'],
'AccountType' => [
'description' => '节点审批人类型：'."\n"
."\n"
.'- DataWorksProjectRole 空间角色'."\n"
.'- DataWorksProjectMember 空间成员'."\n"
.'- TableAdministrator 表负责人'."\n"
.'- TableOrProjectAdministrator 表或空间管理员'."\n"
.'- AliyunResourceOwner 阿里云账号'."\n"
.'- MaxComputeRole MC角色'."\n"
.'- DLFAdmin DlfLegacy管理员'."\n"
.'- DLFNextAdmin DLFNext管理员'."\n"
.'- TenantRole 租户角色'."\n"
.'- EmrAdministrator Emr管理员'."\n"
.'- LindormAdministrator Lindorm管理员'."\n"
.'- AliyunRamUser RAM子账号',
'type' => 'string',
'enumValueTitles' => [
'AliyunResourceOwner' => '阿里云账号', 'MaxComputeRole' => 'MaxCompute角色', 'DLFNextAdmin' => 'DLFNext 管理员', 'TenantRole' => '租户角色', 'DataWorksProjectRole' => '工作空间角色', 'AliyunRamUser' => 'RAM 子账号', 'TableOrProjectAdministrator' => '表或空间管理员', 'EmrAdministrator' => 'Emr 管理员', 'TableAdministrator' => '表负责人', 'DLFAdmin' => 'DlfLegacy 管理员',
'DataWorksProjectMember' => '工作空间成员', 'LindormAdministrator' => 'Lindorm 管理员',
],
'example' => 'DataWorksProjectRole',
],
'Assignees' => [
'description' => '具体指定的审批人。'."\n"
."\n"
.'当AccountType为不同类型，对应不同语义：'."\n"
."\n"
.'- DataWorksProjectMember声明空间成员UserId'."\n"
.'- DataWorksProjectRole声明空间角色code'."\n"
.'- MaxComputeRole声明MC的角色'."\n"
.'- TenantRole声明租户角色code'."\n"
.'- AliyunRamUser声明RAM userId',
'type' => 'array',
'items' => ['description' => '审批人', 'type' => 'string', 'example' => 'role_project_admin'],
],
],
],
'TaskCandidates' => [
'description' => '任务候选审批人列表',
'type' => 'array',
'items' => [
'description' => '候选审批人',
'type' => 'object',
'properties' => [
'MemberUserId' => ['description' => '审批人UserId', 'type' => 'string', 'example' => '207947397776614297'],
'MemberName' => ['description' => '审批人名称', 'type' => 'string', 'example' => '李四'],
],
],
],
],
],
],
'ApprovalProcessDefinition' => [
'description' => '当前流程实例对应的审批策略',
'type' => 'object',
'properties' => [
'Id' => ['description' => '审批策略 ID', 'type' => 'string', 'example' => '323861511451222099'],
'Name' => ['description' => '审批策略名称', 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT'],
'Description' => ['description' => '审批策略描述', 'type' => 'string', 'example' => '流程定义描述'],
'Type' => ['description' => '审批策略类型，枚举：'."\n"
."\n"
.'- MaxCompute'."\n"
.'- DataService'."\n"
.'- DlfV1 【不支持自定义新建】'."\n"
.'- Extension'."\n"
.'- Hologres'."\n"
.'- Emr 【不支持自定义新建】'."\n"
.'- DataAssetGovernance【不支持自定义新建】'."\n"
.'- Lindorm【不支持自定义新建】'."\n"
.'- StarRocks【不支持自定义新建】'."\n"
.'- DlfNext【不支持自定义新建】'."\n"
.'- DataWorks【不支持自定义新建】', 'type' => 'string', 'example' => 'MaxCompute'],
'SubType' => ['description' => '审批策略子类型：'."\n"
."\n"
.'- Table'."\n"
.'- Column'."\n"
.'- Database'."\n"
.'- Schema'."\n"
.'- Default', 'type' => 'string', 'example' => 'Table'],
'Enabled' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'true'],
'RuleConditions' => [
'description' => '审批策略生效规则列表',
'type' => 'array',
'items' => [
'description' => '审批策略生效规则',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '审批策略生效类型：'."\n"
."\n"
.'- odpsProject：指定MaxCompute项目下生效'."\n"
.'- hologresInstanceId：执行Hologres实例下生效'."\n"
.'- sensibleLevel：指定安全等级下生效'."\n"
.'- tableGuid：指定的table下生效'."\n"
.'- projectId：指定的工作空间ID下生效',
'type' => 'string',
'enumValueTitles' => ['tableGuid' => 'tableGuid', 'hologresInstanceId' => 'hologresInstanceId', 'sensibleLevel' => 'sensibleLevel', 'odpsProject' => 'odpsProject', 'projectId' => 'projectId'],
'example' => 'odpsProject',
],
'Expression' => ['description' => '策略生效条件表达式。((#type==\'typeValue\'))。', 'type' => 'string', 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))'],
'Scope' => [
'description' => '规则生效阶段：'."\n"
."\n"
.'- Deployment ：用于判定"提交申请时是否匹配该审批策略'."\n"
."\n"
.'- Running ：用于审批流程执行判定是否免审批【仅支持MaxCompute类型】',
'type' => 'string',
'enumValueTitles' => ['Running' => '流程实例进行时免批', 'Deployment' => '触发申请时生效'],
'example' => 'Deployment',
],
],
],
],
'NotificationServices' => [
'description' => '通知服务列表',
'type' => 'array',
'items' => [
'description' => '通知服务',
'type' => 'object',
'properties' => [
'Channel' => [
'description' => '通知渠道：'."\n"
."\n"
.'- Mail'."\n"
.'- Sms'."\n"
.'- DingRobot'."\n"
.'- Weixin',
'type' => 'string',
'enumValueTitles' => ['Mail' => '邮件', 'Weixin' => 'WebHook', 'Sms' => '短信', 'DingRobot' => '钉钉机器人'],
'example' => 'Mail',
],
'Extension' => ['description' => '扩展信息，JSON 格式，如 {"atAll":"true"}声明是否@所有人', 'type' => 'string', 'example' => '{"atAll":"true"}'],
'Receiver' => ['description' => 'Channel 为DingRobot/Weixin时，需要指定 WebhookUrl 作为接收人', 'type' => 'string', 'example' => 'https://dingtalk'],
],
],
],
'ApprovalNodes' => [
'description' => '审批节点列表',
'type' => 'array',
'items' => [
'description' => '审批节点',
'type' => 'object',
'properties' => [
'Id' => ['description' => '节点id', 'type' => 'string', 'example' => '7a809b6a-2a62-4c6c-9c23-c2a145e3877d'],
'Name' => ['description' => '节点名称', 'type' => 'string', 'example' => 'default-name'],
'AccountType' => ['description' => '节点审批人类型：'."\n"
."\n"
.'- DataWorksProjectRole 空间角色'."\n"
.'- DataWorksProjectMember 空间成员'."\n"
.'- TableAdministrator 表负责人'."\n"
.'- TableOrProjectAdministrator 表或空间管理员'."\n"
.'- AliyunResourceOwner 阿里云账号'."\n"
.'- MaxComputeRole MC角色'."\n"
.'- DLFAdmin DlfLegacy管理员'."\n"
.'- DLFNextAdmin DLFNext管理员'."\n"
.'- TenantRole 租户角色'."\n"
.'- EmrAdministrator Emr管理员'."\n"
.'- LindormAdministrator Lindorm管理员'."\n"
.'- AliyunRamUser RAM子账号', 'type' => 'string', 'example' => 'DataWorksProjectRole'],
'Assignees' => [
'description' => '具体指定的审批人。'."\n"
."\n"
.'当AccountType为不同类型，对应不同语义：'."\n"
."\n"
.'- DataWorksProjectMember声明空间成员UserId'."\n"
.'- DataWorksProjectRole声明空间角色code'."\n"
.'- MaxComputeRole声明MC的角色'."\n"
.'- TenantRole声明租户角色code'."\n"
.'- AliyunRamUser声明RAM userId',
'type' => 'array',
'items' => ['description' => '审批人', 'type' => 'string', 'example' => 'role_project_admin'],
],
'ExtensionProperties' => ['description' => '审批节点扩展说明', 'type' => 'string', 'example' => 'none'],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询审批流程实例',
'description' => '## 请求说明'."\n"
.'通过提供审批流程实例ID，可以查询到该审批流程实例的所有相关信息，如审批流程定义、当前状态下的审批节点以及每个节点上的审批任务详情。此API主要用于监控和管理审批流程的状态。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"ProcessInstance\\": {\\n \\"Id\\": \\"332066440109224007\\",\\n \\"Title\\": \\"MaxCompute表权限申请\\",\\n \\"Status\\": \\"completed\\",\\n \\"Applicator\\": \\"1107558004253538\\",\\n \\"ApplicatorName\\": \\"test_account\\",\\n \\"StartTime\\": \\"2026-05-25 10:20:18 CST\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"AuthErrorMessage\\": \\"S-400007:ODPS acl auth failed. odps table acl auth failed\\",\\n \\"ApprovalTasks\\": [\\n {\\n \\"Id\\": \\"task_001\\",\\n \\"Status\\": \\"Aborted\\",\\n \\"ApprovalComment\\": \\"同意\\",\\n \\"Assignee\\": \\"207947399706614297\\",\\n \\"AssigneeName\\": \\"李四\\",\\n \\"ApprovalDecision\\": \\"Deny\\",\\n \\"CreateTime\\": 1715587200000,\\n \\"CompleteTime\\": 1715590800000,\\n \\"ApprovalNode\\": {\\n \\"Id\\": \\"7a809b6a-2a62-4c6c-9c23-c2a145e3877d\\",\\n \\"Name\\": \\"default-name\\",\\n \\"AccountType\\": \\"DataWorksProjectRole\\",\\n \\"Assignees\\": [\\n \\"role_project_admin\\"\\n ]\\n },\\n \\"TaskCandidates\\": [\\n {\\n \\"MemberUserId\\": \\"207947397776614297\\",\\n \\"MemberName\\": \\"李四\\"\\n }\\n ]\\n }\\n ],\\n \\"ApprovalProcessDefinition\\": {\\n \\"Id\\": \\"323861511451222099\\",\\n \\"Name\\": \\"SYSTEM_GENERATE_DEFAULT\\",\\n \\"Description\\": \\"流程定义描述\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"SubType\\": \\"Table\\",\\n \\"Enabled\\": true,\\n \\"RuleConditions\\": [\\n {\\n \\"Type\\": \\"odpsProject\\",\\n \\"Expression\\": \\"((#odpsProject==\'PX_BEIJING_TEST\'))\\",\\n \\"Scope\\": \\"Deployment\\"\\n }\\n ],\\n \\"NotificationServices\\": [\\n {\\n \\"Channel\\": \\"Mail\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"Receiver\\": \\"https://dingtalk\\"\\n }\\n ],\\n \\"ApprovalNodes\\": [\\n {\\n \\"Id\\": \\"7a809b6a-2a62-4c6c-9c23-c2a145e3877d\\",\\n \\"Name\\": \\"default-name\\",\\n \\"AccountType\\": \\"DataWorksProjectRole\\",\\n \\"Assignees\\": [\\n \\"role_project_admin\\"\\n ],\\n \\"ExtensionProperties\\": \\"none\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'GetProject' => [
'summary' => '该接口用于查询一个DataWorks工作空间的详细信息。',
'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' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n"
."\n"
.'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'],
'Project' => [
'description' => '工作空间详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '28477242'],
'Name' => ['description' => '工作空间名称。', 'type' => 'string', 'example' => 'sora_finance'],
'DisplayName' => ['description' => '工作空间展示名称。', 'type' => 'string', 'example' => 'Sora financial analysis'],
'Description' => ['description' => '工作空间描述。', 'type' => 'string', 'example' => 'Financial analysis group project data development'],
'Owner' => ['description' => '工作空间拥有者UserId，即阿里云账号ID。', 'type' => 'string', 'example' => '207947397706614299'],
'AliyunResourceGroupId' => ['description' => '工作空间所属阿里云资源组ID。', 'type' => 'string', 'example' => 'rg-acfmzbn7pti3zfa'],
'Status' => [
'description' => '空间状态：'."\n"
."\n"
.'- Available：工作空间运行正常'."\n"
.'- Initializing：初始化工作空间'."\n"
.'- InitFailed：工作空间初始化失败'."\n"
.'- Forbidden：手动禁用工作空间'."\n"
.'- Deleting：正在删除工作空间'."\n"
.'- DeleteFailed：工作空间删除失败'."\n"
.'- Frozen：工作空间欠费冻结'."\n"
.'- Updating：更新工作空间中'."\n"
.'- UpdateFailed：更新工作空间失败',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Available',
],
'PaiTaskEnabled' => ['description' => '是否启用PAI任务调度：'."\n"
."\n"
.'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n"
."\n"
.'- false 禁用PAI任务调度。', 'type' => 'boolean', 'example' => 'true'],
'DevEnvironmentEnabled' => ['description' => '是否启用开发环境：'."\n"
."\n"
.'- true 工作空间启用开发环境，支持开发与生产环境隔离。'."\n"
."\n"
.'- false 仅使用生产环境。', 'type' => 'boolean', 'example' => 'true'],
'DevRoleDisabled' => ['description' => '是否禁用开发角色：'."\n"
."\n"
.'- false，开启开发角色'."\n"
."\n"
.'- true，禁用开发角色', 'type' => 'boolean', 'example' => 'false'],
'AliyunResourceTags' => [
'description' => '标签组。',
'type' => 'array',
'items' => [
'description' => '标签详情。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'batch'],
'Value' => ['description' => '标签值。', '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' => '获取工作空间详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetProjectMember' => [
'summary' => '查询工作空间成员详情。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '88757'],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'Dataworks账号 ID。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看需要操作的账号 ID。', 'type' => 'string', 'required' => true, 'example' => '123422****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'],
'ProjectMember' => [
'description' => '工作空间成员详情。',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => '工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '88757'],
'UserId' => ['description' => 'Dataworks账号 ID。', 'type' => 'string', 'example' => '123422344899'],
'Status' => ['description' => '工作空间成员状态。'."\n"
."\n"
.'- Normal 正常。'."\n"
."\n"
.'- Forbidden 已禁用。', 'type' => 'string', 'example' => 'Normal'],
'Roles' => [
'description' => '工作空间成员已经授予的空间角色列表。',
'type' => 'array',
'items' => [
'description' => '已授予的空间角色详情。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '工作空间的角色 Code。'."\n"
."\n"
.'Dataworks系统内置的工作空间角色：'."\n"
."\n"
.'- role_project_admin 空间管理员'."\n"
.'- role_project_dev 开发'."\n"
.'- role_project_dg_admin 数据治理管理员'."\n"
.'- role_project_guest 访客'."\n"
.'- role_project_security 安全管理员'."\n"
.'- role_project_deploy 部署'."\n"
.'- role_project_owner 工作空间所有者'."\n"
.'- role_project_data_analyst 数据分析师'."\n"
.'- role_project_pe 运维'."\n"
.'- role_project_erd 模型设计师', 'type' => 'string', 'example' => 'role_project_guest'],
'Name' => ['description' => '工作空间的角色 Name。', 'type' => 'string', 'example' => 'Visitors'],
'Type' => ['description' => '工作空间的角色类型。'."\n"
."\n"
.'- UserCustom 用户自定义角色'."\n"
.'- System 系统角色', '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' => '查询工作空间成员详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetProjectMember',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetProjectRole' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244504',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10002'],
],
[
'name' => 'Code',
'in' => 'query',
'schema' => [
'description' => '工作空间的角色 Code。'."\n"
.'- role_project_admin：空间管理员'."\n"
.'- role_project_dev：开发'."\n"
.'- role_project_dg_admin：数据治理管理员'."\n"
.'- role_project_guest：访客'."\n"
.'- role_project_security：安全管理员'."\n"
.'- role_project_deploy：部署'."\n"
.'- role_project_owner：空间所有者'."\n"
.'- role_project_data_analyst：数据分析师'."\n"
.'- role_project_pe：运维'."\n"
.'- role_project_erd(模型设计师',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'role_project_guest',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '82F28E60-CF48-5EDF-AB25-D806847B97D1'],
'ProjectRole' => [
'description' => '工作空间角色详情',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => 'DataWorks工作空间的ID。'."\n"
."\n"
.'特殊说明：系统默认的工作空间角色，ProjectId返回固定值-1。', 'type' => 'integer', 'format' => 'int64', 'example' => '10002'],
'Code' => [
'description' => '工作空间的角色 Code。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'role_project_guest',
],
'Name' => ['description' => '工作空间的角色 Name。', 'type' => 'string', 'example' => 'Visitors'],
'Type' => [
'description' => '工作空间的角色类型。'."\n"
.'- UserCustom：用户自定义角色'."\n"
.'- System：系统角色',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'System',
],
'ModulePermissions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ModuleId' => ['type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ModuleName' => ['type' => 'string', 'example' => 'HoloStudio'],
'PermissionType' => ['type' => 'string', 'example' => 'Read'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作空间角色详情',
'summary' => '查询工作空间角色详情。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetProjectRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82F28E60-CF48-5EDF-AB25-D806847B97D1\\",\\n \\"ProjectRole\\": {\\n \\"ProjectId\\": 10002,\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleId\\": 2,\\n \\"ModuleName\\": \\"HoloStudio\\",\\n \\"PermissionType\\": \\"Read\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetRerunWorkflowInstancesResult' => [
'summary' => '查询异步重跑工作流实例的结果',
'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' => '操作ID，用于异步查询创建工作流实例的结果，可通过RerunWorkflowInstances接口获得。', 'type' => 'string', 'required' => true, 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'Result' => [
'description' => '工作流实例重跑结果。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '状态。'."\n"
.'NotRun'."\n"
.'Success'."\n"
.'Failure', 'type' => 'string', 'example' => 'Success'],
'FailureMessage' => ['description' => '失败消息。重跑失败后，返回该字段。', '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取重跑工作流实例结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Success\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\\\n\\"\\n }\\n}","type":"json"}]',
],
'GetResource' => [
'summary' => '获取指定文件资源的详细信息。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '文件资源的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '86043887262011****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => 'E871F6C0-2EFF-5790-A00D-C57543EEXXXX'],
'Resource' => [
'description' => '文件资源详情',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => '文件资源所在工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'Name' => ['description' => '文件资源名称', 'type' => 'string', 'example' => 'OpenAPI_Test_Resource. py'],
'Owner' => ['description' => '文件资源责任人', 'type' => 'string', 'example' => '110755000425XXXX'],
'CreateTime' => ['description' => '文件资源创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000'],
'ModifyTime' => ['description' => '文件资源最近更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000'],
'Spec' => ['description' => '描述这个文件资源的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。', 'type' => 'string', 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "Resource",'."\n"
.' "spec": {'."\n"
.' "fileResources": ['."\n"
.' {'."\n"
.' "name": "OpenAPI_Test_Resource.py",'."\n"
.' "id": "631478864897630XXXX",'."\n"
.' "script": {'."\n"
.' "content": "",'."\n"
.' "path": "XX/OpenAPI_Test/Resource_Test/OpenAPI_Test_Resource.py",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_PYTHON"'."\n"
.' }'."\n"
.' },'."\n"
.' "type": "python",'."\n"
.' "file": {'."\n"
.' "storage": {}'."\n"
.' },'."\n"
.' "datasource": {'."\n"
.' "name": "odps_first",'."\n"
.' "type": "odps"'."\n"
.' },'."\n"
.' "metadata": {'."\n"
.' "owner": "110755000425XXXX"'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
'Id' => ['description' => '文件资源的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', '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' => '获取数据开发文件资源详情',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetResourceGroup' => [
'summary' => '根据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' => '通用资源组唯一标识。', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'ResourceGroup' => [
'title' => '资源组详细信息',
'description' => '资源组详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '资源组唯一标识', 'description' => '资源组唯一标识。', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
'Name' => ['title' => '资源组的名称', 'description' => '资源组的名称。', 'type' => 'string', 'example' => 'common_resource_group'],
'Remark' => ['title' => '资源组的备注', 'description' => '资源组的备注。', 'type' => 'string', 'example' => 'Create a common resource group for common tasks'],
'PaymentType' => [
'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ',
'description' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'PrePaid',
'enum' => ['PrePaid', 'PostPaid'],
],
'Status' => [
'title' => '通用资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时。',
'description' => '查询的资源组状态：'."\n"
."\n"
.'- Normal：正常（运行中/服务中）。'."\n"
.'- Stop：冻结（已到期）。'."\n"
.'- Deleted：删除（已释放/已销毁）。'."\n"
.'- Creating：创建中。'."\n"
.'- CreateFailed：创建失败。'."\n"
.'- Updating：更新中（扩容中/缩容中/变配中）。'."\n"
.'- UpdateFailed：更新失败（扩容失败/升级失败）。'."\n"
.'- Deleting：删除中（释放中/销毁中）。'."\n"
.'- DeleteFailed：删除失败（释放失败/销毁失败）。'."\n"
.'- Timeout：操作超时。'."\n"
.'- Freezed：冻结。'."\n"
.'- Starting：启动中。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'Stop', 'Deleted', 'Creating', 'CreateFailed', 'Updating', 'UpdateFailed', 'Deleting', 'DeleteFailed', 'Timeout'],
],
'Spec' => [
'title' => '资源组规格',
'description' => '资源组规格。',
'type' => 'object',
'properties' => [
'Standard' => ['title' => '规格详情', 'description' => '规格详情。', 'type' => 'string', 'example' => '2CU'],
'Amount' => ['title' => '数量', 'description' => '资源数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'ResourceGroupType' => [
'title' => '资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组',
'description' => '资源组类型：'."\n"
."\n"
.'- CommonV2：新版通用资源组；'."\n"
.'- ExclusiveDataIntegration：独享数据集成资源组；'."\n"
.'- ExclusiveScheduler：独享调度资源组；'."\n"
.'- ExclusiveDataService：独享数据服务资源组',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'CommonV2',
'enum' => ['CommonV2', 'ExclusiveDataIntegration', 'ExclusiveScheduler', 'ExclusiveDataService'],
],
'OrderInstanceId' => ['title' => '资源组的订单实例ID', 'description' => '资源组的订单实例ID。', 'type' => 'string', 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX'],
'CreateUser' => ['title' => '创建该资源组的用户ID', 'description' => '创建该资源组的用户ID。', 'type' => 'string', 'example' => '11075500042XXXXX'],
'CreateTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'DefaultVpcId' => ['title' => '通用资源组绑定的默认VPC ID', 'description' => '通用资源组绑定的默认VPC ID。', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX'],
'DefaultVswitchId' => ['title' => '通用资源组绑定的默认交换机ID', 'description' => '通用资源组绑定的默认交换机ID。', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX'],
'AliyunResourceGroupId' => ['title' => '所属阿里云资源组ID', 'description' => '所属阿里云资源组ID。', 'type' => 'string', 'example' => 'rg-aek2kqofrgXXXXX'],
'AliyunResourceTags' => [
'title' => '阿里云标签列表',
'description' => '阿里云标签列表。',
'type' => 'array',
'items' => [
'title' => '阿里云标签',
'description' => '阿里云标签。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签key', 'description' => '标签key。', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '标签value', 'description' => '标签value。', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', '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' => '根据ID获取指定资源组信息',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
],
],
],
],
],
'GetRoute' => [
'summary' => '根据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' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'Route' => [
'title' => '路由详细信息',
'description' => '路由详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '路由ID', 'description' => '路由ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'ResourceGroupId' => ['title' => '所属资源组唯一标识', 'description' => '所属资源组唯一标识。', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777****'],
'ResourceId' => ['title' => '所属网络资源唯一标识', 'description' => '所属网络资源唯一标识。', 'type' => 'string', 'example' => 'ns-679XXXXX'],
'DestinationCidr' => ['title' => '目的路由CIDR', 'description' => '目的路由CIDR。', 'type' => 'string', 'example' => '192.168.0.0/16'],
'CreateTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'NetworkId' => ['title' => '所属网络资源ID', 'description' => '所属网络ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', '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' => '根据ID获取指定路由信息',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetSchema' => [
'summary' => '获取数据地图中给定模式的详细信息，当前支持MaxCompute和Hologres类型。',
'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' => 'ID，可参考ListSchemas接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级空字符占位。'."\n"
."\n"
.'> 对于MaxCompute类型，实例ID层级使用空字符占位，数据库名称为MaxCompute项目名称，且要求该项目已开启三层模型。'."\n"
."\n"
.'几种常用类型ID格式参考如下'."\n"
."\n"
.'`maxcompute-schema:::project_name:schema_name` （要求该项目已开启三层模型）'."\n"
."\n"
.'`holo-schema:instance_id::database_name:schema_name`'."\n"
."\n"
.'> 其中 '."\n"
.'`instance_id`: holo实例ID '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`project_name`: MaxCompute项目名 '."\n"
.'`schema_name`: schema名称', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-schema:::project_name:schema_name'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A89B5D9D-74EA-XXXXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Schema' => ['description' => 'schema信息。', '$ref' => '#/components/schemas/Schema'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A89B5D9D-74EA-XXXXXX\\",\\n \\"Success\\": true,\\n \\"Schema\\": {\\n \\"Id\\": \\"maxcompute-schema:123456XXX::test_project:default\\\\nholo-schema:h-abc123xxx::test_db:test_schema\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456XXX::test_project\\\\nholo-database:h-abc123xxx::test_db\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n}","type":"json"}]',
'title' => '获取数据地图数据库模式信息',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 当前支持MaxCompute和Hologres类型。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetSecurityStrategy' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '**安全策略ID**', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '**API请求ID**', 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
'SecurityStrategy' => [
'description' => '安全策略',
'type' => 'object',
'properties' => [
'Id' => ['description' => '**策略ID**', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
'Name' => ['description' => '**策略名称**', 'type' => 'string', 'example' => '默认数据分析策略'],
'Description' => ['description' => '策略描述'."\n", 'type' => 'string', 'example' => '控制数据分析模块的查询结果安全行为'],
'SchemaName' => [
'description' => 'Schema模板名称'."\n",
'type' => 'string',
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
'ControlModule' => [
'description' => '管控模块'."\n",
'type' => 'string',
'example' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
'ControlSubModule' => [
'description' => '管控子模块'."\n",
'type' => 'string',
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
'ControlDwScope' => [
'description' => '管控范围（Workspace/Tenant）'."\n",
'type' => 'string',
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
'Workspaces' => [
'description' => '关联工作空间ID列表'."\n",
'type' => 'array',
'items' => ['description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '4843434'],
],
'Enabled' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'true'],
'OriginPolicyId' => ['description' => '系统默认策略来源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'Creator' => ['description' => '创建者用户ID', 'type' => 'string', 'example' => '203322746501002787'],
'Updater' => ['description' => '最后更新者用户ID', 'type' => 'string', 'example' => '203322746501002787'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-05-25T20:46:19'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2026-05-25T20:46:19'],
'Content' => [
'description' => '策略内容，内容受 SecurityStrategySchema 约束',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '当前策略关联的 SecurityStrategySchema.name',
'type' => 'string',
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
'DisplayName' => ['description' => '当前策略关联的 SecurityStrategySchema. displayName', 'type' => 'string', 'example' => '数据分析'],
'DisplayNameEn' => ['description' => '当前策略关联的 SecurityStrategySchema. displayNameEn', 'type' => 'string', 'example' => 'Data Query'],
'ControlModule' => [
'description' => '控制模块。当前策略关联的 SecurityStrategySchema.controlModule',
'type' => 'string',
'example' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
'ControlSubModule' => [
'description' => '管控子模块。当前策略关联的 SecurityStrategySchema.controlSubModule',
'type' => 'string',
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
'ControlDwScope' => [
'description' => '生效范围',
'type' => 'string',
'enumValueTitles' => ['Tenant' => 'Tenant', 'Workspace' => 'Workspace'],
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
'SystemPolicyName' => ['description' => '系统策略名称（非空时系统自动创建默认策略）'."\n", 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY'],
'SystemPolicyDisplayName' => ['description' => '系统策略显示名称'."\n", 'type' => 'string', 'example' => 'Default system generate data query policy'],
'Controllers' => [
'description' => '管控项列表，'."\n"
."\n"
.'注意：合法管控项取决于所选 Schema，参考 Controller定义 及 各Schema管控项列表',
'type' => 'array',
'items' => [
'description' => '管控项',
'type' => 'object',
'properties' => [
'Controller' => ['description' => '**管控项标识符**，取值见 各Schema管控项列表', 'type' => 'string', 'example' => 'viewCount'],
'DisplayName' => ['description' => '**显示名称**', 'type' => 'string', 'example' => '查询结果-单次展示记录值上限'],
'DisplayNameEn' => ['description' => '**英文显示名称**', 'type' => 'string', 'example' => 'Query Results - Single Display Record Limit'],
'Enable' => ['description' => '**是否启用该管控项**', 'type' => 'boolean', 'example' => 'true'],
'ControllerValueType' => ['description' => '**值类型**（Boolean/Integer/Long/String）', 'type' => 'string', 'example' => 'Integer'],
'UserConfigValue' => ['description' => '**用户配置值**，类型取决于ControllerValueType', 'type' => 'any', 'example' => '10'],
'BasicEditionDefaultValue' => ['description' => '基础版默认值', 'type' => 'any', 'example' => '10000'],
'StandardEditionDefaultValue' => ['description' => '标准版默认值', 'type' => 'any', 'example' => '10000'],
'ProfessionalEditionDefaultValue' => ['description' => '专业版默认值', 'type' => 'any', 'example' => '10000'],
'EnterpriseEditionDefaultValue' => ['description' => '企业版默认值', 'type' => 'any', 'example' => '10000'],
'BasicEditionIntervalValue' => [
'description' => '基础版有效值区间[min, max]',
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'StandardEditionIntervalValue' => [
'description' => '标准版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'ProfessionalEditionIntervalValue' => [
'description' => '专业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'EnterpriseEditionIntervalValue' => [
'description' => '企业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询安全策略详情',
'summary' => '根据提供的安全策略ID，获取对应的安全策略详细信息。需要Dataworks 租户管理员与安全管理员权限。',
'description' => '## 请求说明'."\n"
.'- 该API用于通过指定的安全策略ID来检索特定安全策略的全部配置信息。'."\n"
.'- 确保提供的`Id`参数值有效且存在，否则将返回错误信息。'."\n"
.'- 返回的数据结构包括了策略的基本信息（如名称、描述等）以及详细的策略内容（如管控项及其设置）。'."\n"
.'- 注意：系统默认策略的部分字段可能不允许修改或删除。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"SecurityStrategy\\": {\\n \\"Id\\": 13,\\n \\"Name\\": \\"默认数据分析策略\\",\\n \\"Description\\": \\"控制数据分析模块的查询结果安全行为\\",\\n \\"SchemaName\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"Workspaces\\": [\\n 4843434\\n ],\\n \\"Enabled\\": true,\\n \\"OriginPolicyId\\": 12,\\n \\"Creator\\": \\"203322746501002787\\",\\n \\"Updater\\": \\"203322746501002787\\",\\n \\"CreateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"UpdateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"Content\\": {\\n \\"Name\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"DisplayName\\": \\"数据分析\\",\\n \\"DisplayNameEn\\": \\"Data Query\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"SystemPolicyName\\": \\"SYSTEM_GENERATE_DEFAULT_DATA_QUERY\\",\\n \\"SystemPolicyDisplayName\\": \\"Default system generate data query policy\\",\\n \\"Controllers\\": [\\n {\\n \\"Controller\\": \\"viewCount\\",\\n \\"DisplayName\\": \\"查询结果-单次展示记录值上限\\",\\n \\"DisplayNameEn\\": \\"Query Results - Single Display Record Limit\\",\\n \\"Enable\\": true,\\n \\"ControllerValueType\\": \\"Integer\\",\\n \\"UserConfigValue\\": \\"10\\",\\n \\"BasicEditionDefaultValue\\": \\"10000\\",\\n \\"StandardEditionDefaultValue\\": \\"10000\\",\\n \\"ProfessionalEditionDefaultValue\\": \\"10000\\",\\n \\"EnterpriseEditionDefaultValue\\": \\"10000\\",\\n \\"BasicEditionIntervalValue\\": [\\n 0\\n ],\\n \\"StandardEditionIntervalValue\\": [\\n 0\\n ],\\n \\"ProfessionalEditionIntervalValue\\": [\\n 0\\n ],\\n \\"EnterpriseEditionIntervalValue\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'GetSkill' => [
'summary' => '根据名称读取单个Skill的详细信息，包括SKILL.md正文与bundle下载链接。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要读取的 Skill 名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-skill'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'Skill' => [
'description' => '技能',
'type' => 'object',
'properties' => [
'CreatorId' => ['description' => '创建者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'ModifierId' => ['description' => '最近修改者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'Name' => ['description' => '**Skill 名称。**'."\n", 'type' => 'string', 'example' => 'my-skill'],
'Description' => ['description' => '**Skill 描述。**'."\n", 'type' => 'string', 'example' => '数据分析技能'],
'Visibility' => ['description' => '**可见性级别。**'."\n", 'type' => 'string', 'example' => 'TENANT'],
'Body' => ['description' => '**SKILL.md 正文。**'."\n", 'type' => 'string', 'example' => '把大象装冰箱需要3步，把冰箱门打开，把大象放进去，把冰箱门关上。'],
'VisibilityScope' => [
'description' => '**可见性范围。**'."\n",
'type' => 'object',
'properties' => [
'ProjectIds' => [
'description' => '**可见的项目 ID 列表。**'."\n",
'type' => 'array',
'items' => ['description' => '项目id列表'."\n"
."\n", 'type' => 'string', 'example' => '123456'],
],
'UserIds' => [
'description' => '可见的用户 ID 列表。'."\n",
'type' => 'array',
'items' => ['description' => '用户 ID', 'type' => 'string', 'example' => '123456'],
],
],
],
'GmtCreateTime' => ['description' => '创建时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'GmtModifiedTime' => ['description' => '最近修改时间（毫秒时间戳）。'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'BundleUrl' => ['description' => 'bundle.zip 下载链接（无需鉴权的临时 URL，过期失效）。'."\n", 'type' => 'string', 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/xxx.zip?Expires=...&Signature=...'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '读取Skill详情',
'description' => '## 请求说明'."\n"
."\n"
.'- **请求参数**：需要提供要读取的Skill名称。'."\n"
.'- **返回参数**：返回Skill的详细信息，包括名称、描述、创建者ID、最近修改者ID、可见性级别及范围、SKILL.md正文、bundle.zip的临时下载链接（无需额外鉴权，但存在有效期）、创建时间和最近修改时间。'."\n"
.'- **注意事项**：`BundleUrl`为临时下载链接，过期后需重新调用本接口获取新的链接。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Skill\\": {\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-skill\\",\\n \\"Description\\": \\"数据分析技能\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"Body\\": \\"把大象装冰箱需要3步，把冰箱门打开，把大象放进去，把冰箱门关上。\\",\\n \\"VisibilityScope\\": {\\n \\"ProjectIds\\": [\\n \\"123456\\"\\n ],\\n \\"UserIds\\": [\\n \\"123456\\"\\n ]\\n },\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\",\\n \\"BundleUrl\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/xxx.zip?Expires=...&Signature=...\\"\\n }\\n}","type":"json"}]',
],
'GetTable' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '267394',
'abilityTreeNodes' => ['FEATUREdideE9XYA6'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => 'ID，可参考ListTables接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n\n"
.'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}:${数据表名称}`，对于不存在的层级使用空字符占位'."\n"
."\n"
.'> 对于maxcompute和dlf类型，实例ID使用空字符占位。'."\n"
."\n"
.'> starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n"
."\n"
.'> 对于maxcompute类型，数据库名称即为maxcompute项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。'."\n"
."\n"
.'几种常用类型ID格式参考如下'."\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`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供 '."\n"
.'`catalog_id`: dlf目录ID '."\n"
.'`project_name`: maxcompute项目名称 '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`schema_name`: schema名称，对于maxcompute类型，仅所属项目开启三层模型后需要提供。若未开启则使用空字符占位 '."\n"
.'`table_name`: 表名称', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
[
'name' => 'IncludeBusinessMetadata',
'in' => 'query',
'schema' => ['description' => '是否包含业务元数据，默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'IncludeExtendedProperties',
'in' => 'query',
'schema' => ['type' => 'boolean'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7B3435F4-2D91-XXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Table' => ['description' => '数据表的详细信息。', '$ref' => '#/components/schemas/Table'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据地图数据表详情',
'summary' => '获取数据地图中给定数据表详情。是否返回业务元数据可选。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B3435F4-2D91-XXX\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"Id\\": \\"dlf-table::catalog_id:database_name::table_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"dlf-database::catalog_id:database_name\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"test_user\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]',
],
'GetTask' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '221964',
'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'ProjectEnv',
'in' => 'query',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Task' => [
'description' => '任务的详细信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '工作流ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'InstanceMode' => ['description' => '实例生成模式。'."\n"
."\n"
.'- T+1（第二天生成）'."\n"
.'- Immediately（立即生成）', 'type' => 'string', 'example' => 'T+1'],
'Type' => ['title' => '任务类型', 'description' => '任务类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位秒', 'description' => '任务执行超时时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'AllAllowed',
],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Script' => [
'title' => '运行脚本信息',
'description' => '运行脚本信息。',
'type' => 'object',
'properties' => [
'Content' => ['description' => '脚本内容。', 'type' => 'string', 'example' => 'echo "helloWorld"'],
'Parameters' => ['description' => '脚本参数列表。', 'type' => 'string', 'example' => 'para1=$bizdate'],
],
],
'Trigger' => [
'title' => '任务触发方式',
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Scheduler',
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'],
],
],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'."\n"],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'Inputs' => [
'title' => '输入信息',
'description' => '输入信息。',
'type' => 'object',
'properties' => [
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '变量名称。', 'type' => 'string', 'example' => 'key1'],
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Constant'."\n",
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'example' => 'Value1'."\n"],
],
],
],
],
'required' => false,
],
'Outputs' => [
'title' => '输出信息',
'description' => '输出信息。',
'type' => 'object',
'properties' => [
'TaskOutputs' => [
'description' => '任务输出定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Output' => ['title' => '输出标识符，示例：pre.odps_sql_demo_0', 'description' => '输出标识符。', 'type' => 'string', 'example' => 'pre.odps_sql_demo_0'],
],
],
],
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '变量名称。', 'type' => 'string', 'example' => 'key1'],
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Constant'."\n",
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'example' => 'value1'],
],
],
],
],
'required' => false,
],
'Dependencies' => [
'title' => '依赖信息',
'description' => '依赖信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '依赖类型',
'description' => '依赖类型。'."\n"
.'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n"
.'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n"
.'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n"
.'- Normal：同周期依赖',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'UpstreamOutput' => ['title' => '依赖任务的输出标识符,或者任务ID', 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）。', 'type' => 'string', 'example' => 'pre.odps_sql_demo_0'],
'UpstreamTaskId' => ['description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）。', 'type' => 'string', 'example' => '1234'],
],
],
],
'SubTasks' => [
'title' => '复杂任务嵌套配置，如循环节点',
'description' => '复杂任务嵌套配置，如循环节点等。',
'type' => 'object',
'properties' => [
'SubTasks' => [
'description' => '子任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '任务的名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Type' => ['title' => '任务类型', 'description' => '任务类型。', 'type' => 'string', 'example' => 'ODPS_SQL'."\n"],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'The baseline ID.'."\n"
."\n"],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位秒', 'description' => '任务执行超时时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'AllAllowed',
],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '180'],
'Trigger' => [
'title' => '任务触发方式',
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Scheduler',
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal'."\n",
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'."\n"],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'."\n"],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'."\n"],
],
],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'."\n"],
],
],
'Id' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。该字段已废弃，请使用EnvType。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'deprecated' => true,
'enumValueTitles' => [],
'example' => 'Prod',
],
'EnvType' => ['description' => '项目环境。'."\n"
."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'."\n"],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'."\n"],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'."\n"],
],
],
],
'Type' => [
'title' => '子任务类型',
'description' => '子任务类型。'."\n"
.'- DoWhile：do-while节点'."\n"
.'- Combined：组合节点'."\n"
.'- ForEach：for-each节点',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Combined',
],
],
],
'Tags' => [
'title' => '任务标签',
'description' => '任务标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'],
],
],
],
'Id' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。项目环境。该字段已废弃，请使用EnvType。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'deprecated' => true,
'enumValueTitles' => [],
'example' => 'Prod',
],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'."\n"],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
],
],
],
'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' => '获取任务的详情',
'summary' => '获取指定的任务的详细信息。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-07T07:52:32.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetTaskInstance' => [
'summary' => '获取指定的任务实例的详细信息。',
'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' => '任务实例的唯一标识符', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77****'],
'TaskInstance' => [
'description' => '任务实例的详细信息。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '对应任务的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'TaskType' => ['title' => '任务类型', 'description' => '对应任务的类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'TaskName' => ['description' => '对应任务的名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowName' => ['description' => '所属工作流的名称。', 'type' => 'string', 'example' => 'Test workflow'],
'TriggerType' => [
'description' => '触发方式类型。可通过调用GetTask接口的返回参数Trigger.Type获取触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Scheduler',
],
'TriggerRecurrence' => [
'description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'WorkflowInstanceId' => ['description' => '所属工作流实例的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowInstanceType' => [
'description' => '所属工作流实例的类型。'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- Manual：手动任务'."\n"
.'- ManualWorkflow：手动工作流'."\n"
.'- Normal：周期调度'."\n"
.'- ManualFlow：手动执行的业务流程',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'UnifiedWorkflowInstanceId' => ['description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Timeout' => ['description' => '任务执行超时时间，单位为秒。'."\n"
."\n"
.'注意：调度系统会对任务的设定值按小时取整。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑'."\n"
.'- FailureAllowed：只有失败可重跑',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'AllAllowed',
],
'RunNumber' => ['description' => '当前运行的次数，默认从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PeriodNumber' => ['description' => '周期序号。表示任务实例处于当天的第几轮周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'BaselineId' => ['description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Script' => [
'description' => '运行脚本信息。',
'type' => 'object',
'properties' => [
'Content' => ['description' => '脚本内容。', 'type' => 'string', 'example' => 'echo "helloWorld"'],
'Parameters' => ['description' => '脚本参数列表。', 'type' => 'string', 'example' => 'para1=$bizdate'],
],
],
'RuntimeResource' => [
'description' => '实例关联资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'Runtime' => [
'description' => '实例运行时信息。',
'type' => 'object',
'properties' => [
'ProcessId' => ['description' => '运行唯一ID。', 'type' => 'string', 'example' => 'T3_123'],
'Gateway' => ['description' => '运行机器。', 'type' => 'string', 'example' => 'cn-shanghai.1.2'],
],
],
'DataSource' => [
'description' => '实例关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'Inputs' => [
'description' => '输入信息。',
'type' => 'object',
'properties' => [
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '变量名称。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Key1',
],
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Constant',
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'example' => 'Value1'],
],
'description' => '',
],
],
],
],
'Outputs' => [
'description' => '输出信息。',
'type' => 'object',
'properties' => [
'TaskOutputs' => [
'description' => '任务输出定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Output' => ['title' => '输出标识符，示例：pre.odps_sql_demo_0', 'description' => '输出标识符。', 'type' => 'string', 'example' => 'pre.odps_sql_demo_0'],
],
'description' => '',
],
],
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '变量名称。', 'type' => 'string', 'example' => 'key1'],
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Constant',
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'example' => 'value1'],
],
'description' => '',
],
],
],
],
'Tags' => [
'title' => '任务标签',
'description' => '任务标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'],
],
'description' => '',
],
],
'Status' => [
'title' => '实例运行状态',
'description' => '实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件校检'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检'."\n"
.'- WaitTrigger（等待外部触发，触发式节点会在等待时间后变成等待触发）',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Success',
],
'TriggerTime' => ['description' => '定时触发时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Bizdate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Id' => ['description' => '任务实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Prod',
],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'WaitingResourceTime' => ['description' => '进入等资源的时刻。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'WaitingTriggerTime' => ['description' => '进入等定时时间的时刻。', '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' => '获取任务实例的详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetTaskInstanceLog' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '240663',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'RunNumber',
'in' => 'query',
'schema' => ['description' => '任务实例的运行次数，最小值为1，默认取最新的一次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'TaskInstanceLog' => ['description' => '任务实例运行日志。', 'type' => 'string', 'example' => 'This is running log'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"TaskInstanceLog\\": \\"This is running log\\"\\n}","type":"json"}]',
'title' => '获取任务实例的运行日志',
'summary' => '获取指定任务实例某一次运行的运行日志。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'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' => '工作流的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Workflow' => [
'description' => '工作流的详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '工作流的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'Workflow'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'Test workflow'],
'Trigger' => [
'description' => '触发方式。',
'type' => 'object',
'properties' => [
'Type' => ['title' => '`Scheduler` 周期触发', 'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发', 'type' => 'string', 'example' => 'Scheduler'],
'Recurrence' => ['description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行', 'type' => 'string', 'example' => 'Normal'],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'],
],
],
'Dependencies' => [
'description' => '依赖信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['title' => '依赖类型', 'description' => '依赖类型。'."\n"
.'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n"
.'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n"
.'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n"
.'- Normal：同周期依赖', 'type' => 'string', 'example' => 'Normal'],
'UpstreamOutput' => ['title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', 'type' => 'string', 'example' => 'pre.odps_sql_demo_0'],
'UpstreamTaskId' => ['title' => '依赖任务的任务ID, DependencyType=CrossCycleDependsOnOtherNode时 需要填此值', 'description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
],
],
],
'Parameters' => ['description' => '参数列表。', 'type' => 'string', 'example' => 'para1=$bizdate para2=$[yyyymmdd] '],
'Tasks' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'Name' => ['description' => '任务的名称。', 'type' => 'string', 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'Test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Type' => ['title' => '任务类型', 'description' => '任务类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位为秒', 'description' => '任务执行超时时间，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => ['title' => '任务是否允许重跑的配置', 'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑', 'type' => 'string', 'example' => 'AllAllowed'],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'TriggerRecurrence' => ['description' => '触发时的运行模式。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行', 'type' => 'string', 'example' => 'Normal'],
'ClientUniqueCode' => ['description' => '任务的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', 'type' => 'string', 'example' => 'Task_0bc5213917368545132902xxxxxxxx'],
],
],
],
'Outputs' => [
'title' => '输出信息',
'description' => '输出信息。',
'type' => 'object',
'properties' => [
'TaskOutputs' => [
'description' => '任务输出定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Output' => ['title' => '输出标识符，示例：pre.odps_sql_demo_0', 'description' => '输出标识符。', 'type' => 'string', 'example' => 'pre.odps_sql_demo_0'],
],
],
],
],
],
'Tags' => [
'title' => '任务标签',
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'],
],
],
],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ClientUniqueCode' => ['description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', 'type' => 'string', 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx'],
],
],
],
],
],
],
'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' => '获取工作流的详情',
'summary' => '获取指定的工作流的详细信息。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetWorkflowDefinition' => [
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据开发工作流唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'format' => 'int64', 'required' => true, 'example' => '860438872620****'],
],
[
'name' => 'IncludeScriptContent',
'in' => 'query',
'schema' => ['description' => '查询结果是否包含工作流内部节点的脚本内容（对于内容较多的节点，可能存在较长的网络传输延时）。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'F2BDD628-8A21-5BD1-B930-1A2D5989XXXX'],
'WorkflowDefinition' => [
'description' => '数据开发工作流的详细信息',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => '数据开发工作流所在工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '307XXX'],
'Name' => ['description' => '数据开发工作流名称', 'type' => 'string', 'example' => 'OpenAPI test workflow Demo'],
'Owner' => ['description' => '数据开发工作流的责任人', 'type' => 'string', 'example' => '110755000425XXXX'],
'CreateTime' => ['description' => '数据开发工作流的创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1708481905000'],
'ModifyTime' => ['description' => '数据开发工作流的最近更新时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1708481905000'."\n"],
'Spec' => ['description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。', 'type' => 'string', 'example' => '{'."\n"
.' "metadata": {'."\n"
.' "tenantId": "52425742456XXXX",'."\n"
.' "projectId": "307XXXX",'."\n"
.' "uuid": "463497880880954XXXX"'."\n"
.' },'."\n"
.' "kind": "CycleWorkflow",'."\n"
.' "version": "1.1.0",'."\n"
.' "spec": {'."\n"
.' "name": "OpenAPI_Test_Workflow_Demo",'."\n"
.' "id": "463497880880954XXXX",'."\n"
.' "type": "CycleWorkflow",'."\n"
.' "owner": "110755000425XXXX",'."\n"
.' "workflows": ['."\n"
.' {'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n"
.' "runtime": {'."\n"
.' "command": "WORKFLOW"'."\n"
.' },'."\n"
.' "id": "698002781368644XXXX"'."\n"
.' },'."\n"
.' "id": "463497880880954XXXX",'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "id": "652567824470354XXXX",'."\n"
.' "cron": "00 02 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "strategy": {'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "failureStrategy": "Break"'."\n"
.' },'."\n"
.' "name": "OpenAPI_Test_Workflow_Demo",'."\n"
.' "owner": "110755000425XXXX",'."\n"
.' "metadata": {'."\n"
.' "owner": "110755000425XXXX",'."\n"
.' "ownerName": "XXXX@test.XXXX.com",'."\n"
.' "tenantId": "52425742456XXXX",'."\n"
.' "project": {'."\n"
.' "mode": "STANDARD",'."\n"
.' "projectId": "307303",'."\n"
.' "projectIdentifier": "lwttest_standard",'."\n"
.' "projectName": "XXXX",'."\n"
.' "projectOwnerId": "110755000425XXXX",'."\n"
.' "simple": false,'."\n"
.' "tenantId": "52425742456XXXX"'."\n"
.' },'."\n"
.' "projectId": "307XXXX"'."\n"
.' },'."\n"
.' "inputs": {},'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "463497880880954XXXX",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "OpenAPI_Test_Workflow_Demo",'."\n"
.' "isDefault": true'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "nodes": [],'."\n"
.' "dependencies": []'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
'WorkflowId' => ['description' => '发布后在调度侧的工作流ID', 'type' => 'integer', 'format' => 'int64', 'example' => '700006657495'],
'Id' => ['description' => '数据开发工作流唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'format' => 'int64', 'example' => '463497880880954XXXX'],
],
],
],
],
],
],
'title' => '获取数据开发工作流详情',
'summary' => '调用该接口，可以获取指定工作流的详细信息。',
'changeSet' => [
['createdAt' => '2025-02-18T02:45:10.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-18T01:56:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2BDD628-8A21-5BD1-B930-1A2D5989XXXX\\",\\n \\"WorkflowDefinition\\": {\\n \\"ProjectId\\": 0,\\n \\"Name\\": \\"OpenAPI test workflow Demo\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1708481905000,\\n \\"ModifyTime\\": 1708481905000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"463497880880954XXXX\\\\\\"\\\\n },\\\\n \\\\\\"kind\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"workflows\\\\\\": [\\\\n {\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"WORKFLOW\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"698002781368644XXXX\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"trigger\\\\\\": {\\\\n \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"652567824470354XXXX\\\\\\",\\\\n \\\\\\"cron\\\\\\": \\\\\\"00 02 00 * * ?\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\",\\\\n \\\\\\"delaySeconds\\\\\\": 0\\\\n },\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"timeout\\\\\\": 0,\\\\n \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\",\\\\n \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\",\\\\n \\\\\\"rerunTimes\\\\\\": 3,\\\\n \\\\\\"rerunInterval\\\\\\": 180000,\\\\n \\\\\\"failureStrategy\\\\\\": \\\\\\"Break\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"ownerName\\\\\\": \\\\\\"XXXX@test.XXXX.com\\\\\\",\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"project\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"STANDARD\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307303\\\\\\",\\\\n \\\\\\"projectIdentifier\\\\\\": \\\\\\"lwttest_standard\\\\\\",\\\\n \\\\\\"projectName\\\\\\": \\\\\\"XXXX\\\\\\",\\\\n \\\\\\"projectOwnerId\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"simple\\\\\\": false,\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\"\\\\n },\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\"\\\\n },\\\\n \\\\\\"inputs\\\\\\": {},\\\\n \\\\\\"outputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\",\\\\n \\\\\\"refTableName\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"isDefault\\\\\\": true\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"nodes\\\\\\": [],\\\\n \\\\\\"dependencies\\\\\\": []\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"WorkflowId\\": 700006657495,\\n \\"Id\\": \\"463497880880954XXXX\\"\\n }\\n}","type":"json"}]',
],
'GetWorkflowInstance' => [
'summary' => '获取指定的工作流实例的详细信息。',
'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' => '工作流实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'WorkflowInstance' => [
'description' => '工作流实例的详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '工作流实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowTaskInstanceId' => ['description' => '工作流实例对应的任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'UnifiedWorkflowInstanceId' => ['description' => '统一工作流实例Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'WorkInstance1'],
'Type' => ['title' => '工作流类型', 'description' => '工作流实例的类型。'."\n"
.'- Normal：周期调度'."\n"
.'- Manual：手动任务'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- ManualWorkflow：手动工作流'."\n"
.'- TriggerWorkflow：触发式工作流', 'type' => 'string', 'example' => 'Normal'],
'Status' => ['description' => '工作流实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件检验'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检', 'type' => 'string', 'example' => 'Success'],
'BizDate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '工作流的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'WorkflowParameters' => ['description' => '工作流参数。', 'type' => 'string', 'example' => '周期工作流：'."\n"
.'key1=value1 key2=value2'."\n"
.'手动业务流程：'."\n"
.'{"key1":"value1", "key2": "value2"}'],
'Tags' => [
'title' => '任务标签',
'description' => '任务标签',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
'Value' => ['description' => '标签值。', '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' => '获取工作流实例的详情',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GrantMemberProjectRoles' => [
'summary' => '授予工作空间成员角色。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '105149'],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks账号 ID 。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看授予新角色的账号 ID。', 'type' => 'string', 'required' => true, 'example' => '123422344899'],
],
[
'name' => 'RoleCodes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作空间角色 Code 列表。 您可以调用 [ListProjectRoles](~~2853930~~) 获取角色的 Code。 '."\n"
."\n"
.'该参数用来描述本次 API 调用操作将要新增授予的工作空间角色 。',
'type' => 'array',
'items' => ['description' => '工作空间角色 Code 。', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest'],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', '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' => '授予工作空间成员新的空间角色',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:GrantMemberProjectRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ImportCertificate' => [
'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' => '证书文件所属项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '106560'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '证书文件名称。'."\n"
.'在一个项目空间中，'."\n"
.'证书文件名称不允许重复。', 'type' => 'string', 'required' => true, 'example' => 'ca1.crt'],
],
[
'name' => 'CertificateFile',
'in' => 'query',
'schema' => ['description' => '需要上传的认证文件，'."\n"
.'上传方式：通过构造InputStream上传文件。', 'type' => 'string', 'required' => true, 'example' => '-', 'isFileTransferUrl' => true],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'This is a file'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '证书文件ID，即证书文件的唯一标识符。', 'description' => '证书文件ID，'."\n"
.'即证书文件的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '676303114031776'],
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '导入认证文件',
'summary' => '导入认证文件。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色： 租户所有者、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 676303114031776,\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\"\\n}","type":"json"}]',
],
'ImportWorkflowDefinition' => [
'summary' => '调用此接口，可以将通过FlowSpec定义的工作流节点和其内部的子节点都导入到数据开发中。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '246297',
'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/)。'."\n"
."\n"
.'> 如何快速获取FlowSpec模板？'."\n"
.'> - 在数据开发中打开工作流->点击右上角“显示Spec，即可得到针对当前工作流的FlowSpec描述。可以基于该FlowSpec描述快速构建符合要求的模板。'."\n"
."\n"
.'>该接口支持同时创建Workflow和其内部节点，因此请注意FlowSpec中填写的ID。如果当前ID已经存在，则会变为更新操作，只有不填写ID或ID不存在时才会变为创建操作。>', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "CycleWorkflow",'."\n"
.' "spec": {'."\n"
.' "name": "Asynchronous_Workflow_Creation_Test",'."\n"
.' "id": "632647691239009XXXX",'."\n"
.' "type": "CycleWorkflow",'."\n"
.' "workflows": ['."\n"
.' {'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test",'."\n"
.' "runtime": {'."\n"
.' "command": "WORKFLOW"'."\n"
.' }'."\n"
.' },'."\n"
.' "id": "632647691239009XXXX",'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "cron": "00 03 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "strategy": {'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "failureStrategy": "Break"'."\n"
.' },'."\n"
.' "name": "Asynchronous_Workflow_Creation_Test",'."\n"
.' "inputs": {},'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "632647691239009XXXX",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "Asynchronous_Workflow_Creation_Test"'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "nodes": ['."\n"
.' {'."\n"
.' "recurrence": "Normal",'."\n"
.' "id": "742981001612325XXXX",'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/111",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_SQL"'."\n"
.' },'."\n"
.' "content": "select now();\\n"'."\n"
.' },'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "cron": "00 24 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "name": "111",'."\n"
.' "inputs": {},'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "742981001612325XXXX",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "111"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "recurrence": "Normal",'."\n"
.' "id": "595182137303408XXXX",'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/222",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_SQL"'."\n"
.' },'."\n"
.' "content": "select now();\\n select 1;"'."\n"
.' },'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "cron": "00 00 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "name": "222",'."\n"
.' "inputs": {},'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "595182137303408XXXX",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "222" '."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ],'."\n"
.' "dependencies": ['."\n"
.' {'."\n"
.' "nodeId": "595182137303408XXXX",'."\n"
.' "depends": ['."\n"
.' {'."\n"
.' "type": "Normal",'."\n"
.' "output": "742981001612325XXXX",'."\n"
.' "refTableName": "111"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
],
[
'name' => 'DryRun',
'in' => 'formData',
'schema' => ['description' => '是否以校验模式调用本接口。取值为 true 时,仅对传入的 workflow spec 做合法性校验,复用真实导入的预处理与校验逻辑(规则完全一致),但不落库、不执行任何写操作;校验结果通过异步任务返回,校验不通过时异步任务失败,错误明细包含错误码、错误信息,以及定位到具体节点的 JSONPath(如 $.spec.workflows[0].nodes[1])。'."\n"
."\n"
.'取值默认为false，此时按正常逻辑真实导入。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F'],
'AsyncJob' => [
'description' => '异步任务状态信息。',
'type' => 'object',
'properties' => [
'Completed' => ['description' => '异步任务是否完成。', 'type' => 'boolean', 'example' => 'false'],
'CreateTime' => ['description' => '异步任务创建时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1706581425000'],
'Error' => ['description' => '当异步任务失败时的错误信息。', 'type' => 'string', 'example' => 'target folder already exists: XXXX'],
'Id' => ['description' => '异步任务的ID。', 'type' => 'string', 'example' => '1234567691239009XXXX'],
'Progress' => ['description' => '异步任务完成进度，范围区间为0-100', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Response' => ['description' => '该异步任务希望返回的内容。'."\n"
."\n"
.'> 该字段目前存放在异步任务中被创建的工作流的ID。', 'type' => 'string', 'example' => '632647691239009XXXX'],
'Status' => [
'description' => '异步任务的状态。'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Running 正在运行'."\n"
.'- Success 执行成功'."\n"
.'- Fail 执行失败'."\n"
.'- Cancel 任务被取消',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Running',
],
'Type' => [
'description' => '异步任务操作类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Create 创建，创建一个资源的Job。 '."\n"
.'- Cancel 取消，取消某一个创建Job。',
'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"}]',
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => '导入数据开发工作流',
'description' => '>'."\n"
."\n"
.'- 该接口不支持导入多个工作流，若FlowSpec中定义了不止一个工作流，则除第一个以外的后续工作流将被忽略。'."\n"
."\n"
.'- 这是一个异步接口，调用该接口将返回一个异步任务的对象。任务具体的执行状态需要调用GetJobStatus查询。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListAgentSessionArtifacts' => [
'summary' => '查询指定会话产出的Artifact文件列表。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '10001'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '会话 ID，缺失报错 `sessionCode` is required'."\n", 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34'],
'RequestId' => ['description' => '按单次请求 code 过滤，仅看该请求产出的 artifact'."\n", 'type' => 'string', 'required' => false, 'example' => 'req_20260421_001'],
'MaxResults' => ['description' => '单页条数，默认 50'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
'NextToken' => ['description' => 'OSS 下一页 continuation token，首页不传'."\n", 'type' => 'string', 'required' => false, 'example' => 'CAESExFsbyH...'],
],
'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' => '0000-ABCD-E****'],
'JsonRpcResponse' => [
'description' => 'JSON-PRC的返回结果',
'type' => 'object',
'properties' => [
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'example' => '28477817'],
'Result' => [
'description' => '模型产出物的分页信息',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一页 token，末页为 null', 'type' => 'string', 'example' => 'CAESExFsbyH...'],
'MaxResults' => ['description' => '实际生效的单页条数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '29'],
'Artifacts' => [
'description' => '模型产出物列表',
'type' => 'array',
'items' => [
'description' => '模型产出物信息。',
'type' => 'object',
'properties' => [
'ArtifactName' => ['description' => '模型产出物名称', 'type' => 'string', 'example' => 'mock_report.md'],
'ArtifactType' => ['description' => '模型产出物类型，一般是文件后缀', 'type' => 'string', 'example' => 'md'],
'ArtifactPath' => ['description' => '模型产出物路径', 'type' => 'string', 'example' => 'mock/mock_report.md'],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询会话Artifact列表',
'description' => '## 请求说明'."\n"
.'- 该接口用于查询特定会话中生成的所有Artifact文件，支持通过`Params.RequestId`参数过滤单次请求产生的文件。'."\n"
.'- `NextToken`参数用于分页获取更多结果，首次调用时无需提供此值。'."\n"
.'- 默认情况下，每页最多返回50条记录，可以通过`MaxResults`参数调整这一数值。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"28477817\\",\\n \\"Result\\": {\\n \\"NextToken\\": \\"CAESExFsbyH...\\",\\n \\"MaxResults\\": 29,\\n \\"Artifacts\\": [\\n {\\n \\"ArtifactName\\": \\"mock_report.md\\",\\n \\"ArtifactType\\": \\"md\\",\\n \\"ArtifactPath\\": \\"mock/mock_report.md\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'ListAgentSessions' => [
'summary' => '加载Agent Session对话历史列表。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '676303114031776'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
'AgentName' => ['description' => '**Agent 名称** 精确过滤；与 `SessionSourceList` 至少传一个', 'type' => 'string', 'required' => false, 'example' => 'chat_cli_chatbi'],
'SessionSourceList' => [
'description' => '**会话来源列表** 过滤；与 `AgentName` 至少传一个',
'type' => 'array',
'items' => ['description' => 'SessionSource', 'type' => 'string', 'required' => false, 'example' => 'pop-sdk'],
'required' => false,
],
'TagList' => [
'description' => '会话标签 code 列表过滤'."\n",
'type' => 'array',
'items' => ['description' => '标签', 'type' => 'string', 'required' => false, 'example' => 'user_123456'],
'required' => false,
],
'SessionId' => ['description' => 'sessionId 精确匹配'."\n", 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34'],
'SessionTitle' => ['description' => '会话标题模糊过滤'."\n", 'type' => 'string', 'required' => false, 'example' => 'Sales in the last 30 days'],
'MaxResults' => ['description' => '单页条数；默认 50'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
'NextToken' => ['description' => '下一页 token，首页传1', 'type' => 'string', 'required' => false, 'example' => '10'],
],
'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' => '50C5A9F7-B5BD-58B2-9EB8-ADFFA9E6A56F'],
'JsonRpcResponse' => [
'description' => 'JSON-PRC的返回结果',
'type' => 'object',
'properties' => [
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'example' => '29d9a29c-a284-48c1-9eaa-4a42c7c616d5'],
'Result' => [
'description' => 'Session查询分页结果集',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '匹配到的会话总数', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'MaxResults' => ['description' => '实际生效的单页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['description' => '下一页 token，首页传1', 'type' => 'string', 'example' => '1'],
'AgentSessions' => [
'description' => '会话列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '会话唯一 ID', 'type' => 'string', 'example' => 'sess_0f12abc34'],
'SessionTitle' => ['description' => '会话标题'."\n", 'type' => 'string', 'example' => 'Sales analysis for the last 30 days'],
'SessionDescription' => ['description' => '会话描述'."\n", 'type' => 'string', 'example' => 'Sales trend analysis'],
'SessionCreatedAt' => ['description' => '会话创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'],
'SessionUpdatedAt' => ['description' => '会话修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'],
'Meta' => [
'description' => 'DataWorks扩展的Session信息，非ACP标准协议的',
'type' => 'object',
'properties' => [
'SessionStatus' => ['description' => '会话连接状态。', 'type' => 'string', 'example' => '* NORMAL: 无状态的session'."\n"
.'* INIT: 初始化状态'."\n"
.'* RUNNING: 运行中'."\n"
.'* RELEASED: 释放状态'],
'SessionSource' => ['description' => '会话来源', 'type' => 'string', 'example' => 'openapi_sdk'],
'SessionTagList' => [
'description' => '会话标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SessionTagCode' => ['description' => '会话标签。可以基于会话标签进行过滤，比如调用OpenAPI的时候用的是固定的RAM子账号，但是调用系统中有自己的账号体系，此时需要基于账号ID过滤Session列表，该标签就可以传调用系统的账号ID。', 'type' => 'string', 'example' => 'user_123456'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询会话列表',
'description' => '## 请求说明'."\n"
.'- `agentName` 和 `sessionSourceList` 至少需要提供一个。'."\n"
.'- 支持通过 `tagList`, `sessionId`, `sessionTitle` 进行组合过滤。'."\n"
.'- 返回结果符合阿里云 OpenAPI 分页规范，包括 `totalCount`, `maxResults`, `nextToken` 以及 `sessionList`。'."\n"
.'- 如果 `nextToken` 为非法字符串，则默认处理为 1。'."\n"
.'- 默认每页返回 50 条记录，可以通过 `maxResults` 参数调整。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50C5A9F7-B5BD-58B2-9EB8-ADFFA9E6A56F\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"29d9a29c-a284-48c1-9eaa-4a42c7c616d5\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 200,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"1\\",\\n \\"AgentSessions\\": [\\n {\\n \\"SessionId\\": \\"sess_0f12abc34\\",\\n \\"SessionTitle\\": \\"Sales analysis for the last 30 days\\",\\n \\"SessionDescription\\": \\"Sales trend analysis\\",\\n \\"SessionCreatedAt\\": 123456789,\\n \\"SessionUpdatedAt\\": 123456789,\\n \\"Meta\\": {\\n \\"SessionStatus\\": \\"* NORMAL: 无状态的session\\\\n* INIT: 初始化状态\\\\n* RUNNING: 运行中\\\\n* RELEASED: 释放状态\\",\\n \\"SessionSource\\": \\"openapi_sdk\\",\\n \\"SessionTagList\\": [\\n {\\n \\"SessionTagCode\\": \\"user_123456\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'ListAgents' => [
'summary' => '查询当前租户可用的Agent列表，支持按名称过滤和分页。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '4as3dasf654a'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '此次请求的具体参数内容',
'type' => 'object',
'properties' => [
'AgentName' => ['description' => 'Agent 名称精确过滤；不传时返回所有 Agent'."\n", 'type' => 'string', 'required' => false, 'example' => 'chat_cli_chatbi'],
'MaxResults' => ['description' => '单页条数；默认 50'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
'NextToken' => ['description' => '下一页 token，阿里云 OpenAPI 规范；首页不传，翻页时传上一页返回的 nextToken'."\n", 'type' => 'string', 'required' => false, 'example' => '0'],
],
'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' => '4003B739-C33C-5297-B810-0490EEE5A767'],
'JsonRpcResponse' => [
'description' => '符合Jsonrpc规范的返回结果对象',
'type' => 'object',
'properties' => [
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'example' => '70623e38-a889-4192-930a-752ffdd75f48'],
'Result' => [
'description' => 'Agent分页查询结果',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '匹配到的 Agent 总数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '27'],
'MaxResults' => ['description' => '实际生效的单页条数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['description' => '下一页 token，末页或无数据时为 null'."\n", 'type' => 'string', 'example' => '2'],
'Agents' => [
'description' => 'Agent 列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AgentName' => ['description' => 'Agent 名称'."\n", 'type' => 'string', 'example' => 'chat_cli_chatbi'],
],
'description' => '',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询Agent列表',
'description' => '## 请求说明'."\n"
.'- 该接口用于查询当前租户下所有可用的Agent。'."\n"
.'- 支持通过`agentName`参数进行精确匹配过滤。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListAgents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4003B739-C33C-5297-B810-0490EEE5A767\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"70623e38-a889-4192-930a-752ffdd75f48\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 27,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"2\\",\\n \\"Agents\\": [\\n {\\n \\"AgentName\\": \\"chat_cli_chatbi\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'ListAlertRules' => [
'summary' => '分页获取自定义监控告警规则。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '249251',
'abilityTreeNodes' => ['FEATUREdideRJGWWC'],
],
'parameters' => [
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => '自定义规则的责任人阿里云UID。', 'type' => 'string', 'required' => false, 'example' => '1933790683****'],
],
[
'name' => 'TaskIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '调度任务ID列表',
'type' => 'array',
'items' => ['description' => '调度任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
],
[
'name' => 'Types',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '触发告警的类型列表。',
'type' => 'array',
'items' => ['description' => '触发告警的类型，枚举值：'."\n"
.'- Finished: 实例完成'."\n"
.'- UnFinished: 实例未完成'."\n"
.'- Error: 实例出错'."\n"
.'- CycleUnfinished: 实例周期未完成'."\n"
.'- Timeout: 实例超时'."\n"
.'- InstanceTransferComplete: 任务转实例完成'."\n"
.'- InstanceTransferFluctuate: 实例数量波动'."\n"
.'- ExhaustedError: 自动重跑后仍出错'."\n"
.'- InstanceKeyword: 出错实例包含关键词'."\n"
.'- InstanceErrorCount: 出错实例数量'."\n"
.'- InstanceErrorPercentage: 出错实例占比 '."\n"
.'- ResourceGroupPercentage: 资源组利用率'."\n"
.'- ResourceGroupWaitCount: 资源组等资源实例数', 'type' => 'string', 'required' => false, 'example' => 'Error'],
'required' => false,
],
],
[
'name' => 'Receiver',
'in' => 'query',
'schema' => ['description' => '告警接收人阿里云UID。', 'type' => 'string', 'required' => false, 'example' => '1933790683****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义规则名', 'type' => 'string', 'required' => false, 'example' => 'error_rule'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码数，用于翻页，最小值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，最大100条。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '100', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的 ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D938048****'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'AlertRules' => [
'description' => '一组自定义规则。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '自定义规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '22125'],
'Name' => ['description' => '自定义规则名。', 'type' => 'string', 'example' => 'error_test'],
'Owner' => ['description' => '自定义规则的责任人阿里云UID。', 'type' => 'string', 'example' => '1933790683****'],
'Enabled' => ['description' => '告警规则是否启用。', 'type' => 'boolean', 'example' => 'true'],
'TriggerCondition' => [
'description' => '触发告警的条件。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '触发告警的类型，枚举值：'."\n"
.'- Finished: 实例完成'."\n"
.'- UnFinished: 实例未完成'."\n"
.'- Error: 实例出错'."\n"
.'- CycleUnfinished: 实例周期未完成'."\n"
.'- Timeout: 实例超时'."\n"
.'- InstanceTransferComplete: 任务转实例完成'."\n"
.'- InstanceTransferFluctuate: 实例数量波动'."\n"
.'- ExhaustedError: 自动重跑后仍出错'."\n"
.'- InstanceKeyword: 出错实例包含关键词'."\n"
.'- InstanceErrorCount: 出错实例数量'."\n"
.'- InstanceErrorPercentage: 出错实例占比 '."\n"
.'- ResourceGroupPercentage: 资源组利用率'."\n"
.'- ResourceGroupWaitCount: 资源组等资源实例数', 'type' => 'string', 'example' => 'Error'],
'Extension' => [
'description' => '扩展信息，部分触发条件需要配置。',
'type' => 'object',
'properties' => [
'Error' => [
'description' => '出错告警配置。',
'type' => 'object',
'properties' => [
'StreamTaskIds' => [
'description' => '实时计算任务监控时填入对应的任务ID',
'type' => 'array',
'items' => ['description' => '实时计算任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
'AutoRerunAlertEnabled' => ['description' => '离线任务由于失败自动重跑，是否产生告警。', 'type' => 'boolean', 'example' => 'false'],
],
],
'Timeout' => [
'description' => '超时告警配置',
'type' => 'object',
'properties' => [
'TimeoutInMinutes' => ['description' => '超时时间，单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'UnFinished' => [
'description' => '未完成告警配置。',
'type' => 'object',
'properties' => [
'UnFinishedTime' => ['description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'example' => '12:00'],
],
],
'CycleUnfinished' => [
'description' => '周期未完成告警配置。',
'type' => 'object',
'properties' => [
'CycleAndTime' => [
'description' => '周期和时间配置列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CycleId' => ['description' => '周期ID，取值范围为[1,288]。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Time' => ['description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'example' => '01:00'],
],
],
],
],
],
'InstanceErrorCount' => [
'description' => '任务实例出错数量告警配置。',
'type' => 'object',
'properties' => [
'Count' => ['description' => '出错的任务实例数，取值范围为[1,10000]。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'InstanceErrorPercentage' => [
'description' => '任务实例出错比例告警配置。',
'type' => 'object',
'properties' => [
'Percentage' => ['description' => '出错实例占比，取值范围 [1-100]。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'InstanceTransferFluctuate' => [
'description' => '转实例数量波动告警配置。',
'type' => 'object',
'properties' => [
'Trend' => ['description' => '转实例波动类型，枚举值：'."\n"
.'- abs: 绝对值'."\n"
.'- increase: 增长'."\n"
.'- decrease: 下降', 'type' => 'string', 'example' => 'abs'],
'Percentage' => ['description' => '转实例波动百分比，取值范围[1-100]。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'Target' => [
'description' => '监控对象。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型，枚举值：'."\n"
.'- Task: 任务节点'."\n"
.'- Baseline: 基线'."\n"
.'- Project: 工作空间'."\n"
.'- BizProcess - 业务流程', 'type' => 'string', 'example' => 'Task'],
'Ids' => [
'description' => '监控对象ID列表。',
'type' => 'array',
'items' => ['description' => '监控对象ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '32567'],
],
'AllowTasks' => [
'description' => '监控任务白名单列表。',
'type' => 'array',
'items' => ['description' => '监控任务白名单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123123'],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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' => '获取自定义规则列表',
'changeSet' => [
['createdAt' => '2024-12-27T03:06:33.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '请求的数据页数，'."\n"
.'用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为10条，'."\n"
.'最大100条。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'Keyword',
'in' => 'formData',
'schema' => ['description' => '关键字，'."\n"
.'用于模糊匹配业务流程的名称。', 'type' => 'string', 'required' => false, 'example' => 'my'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果 。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功'."\n"
.'。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '业务流程列表的详情'."\n"
.'。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '当前的页数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '当前数据页的数据条数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '满足查询条件的总数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
'Business' => [
'description' => '业务流程列表信息'."\n"
.'。',
'type' => 'array',
'items' => [
'description' => '业务流程列表信息'."\n"
.'。',
'type' => 'object',
'properties' => [
'Owner' => ['description' => '业务流程的责任人'."\n"
.'。', 'type' => 'string', 'example' => '34824327****'],
'Description' => ['description' => '业务流程的描述信息'."\n"
.'。', 'type' => 'string', 'example' => 'test'],
'ProjectId' => ['description' => '业务流程所在工作空间的id'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'BusinessId' => ['description' => '业务流程的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001'],
'BusinessName' => ['description' => '业务流程的名称'."\n"
.'。', 'type' => 'string', 'example' => 'test'],
'UseType' => ['description' => '业务流程所属的功能模块，包括NORMAL（数据开发）和MANUAL_BIZ（手动业务流程）'."\n"
.'。', 'type' => 'string', 'example' => 'NORMAL'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Business\\": [\\n {\\n \\"Owner\\": \\"34824327****\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": 10000,\\n \\"BusinessId\\": 3000001,\\n \\"BusinessName\\": \\"test\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询业务流程的列表',
'summary' => '调用ListBusiness查询业务流程的列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListCatalogs' => [
'summary' => '查询数据地图下的数据目录列表，当前支持dlf与starrocks类型。'."\n"
.'dlf类型返回支持的所有数据目录列表，starrocks类型返回特定实例下的数据目录列表。',
'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' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n\n"
.'当前支持dlf与starrocks类型。'."\n"
."\n"
.'- 对于dlf类型，支持查询所有目录列表，`ParentMetaEntityId`格式为 `dlf`'."\n"
."\n"
.'- 对于starrocks类型，支持查询特定实例下的数据目录列表，`ParentMetaEntityId`格式为 `starrocks:(instance_id|encoded_jdbc_url)`'."\n"
."\n"
.'>其中 '."\n"
.'`instance_id`: 实例ID，对应数据源以实例模式注册时需要提供 '."\n"
.'`encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供', 'type' => 'string', 'required' => true, 'example' => 'dlf'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '名称，模糊匹配', 'description' => '名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['title' => '注释，模糊匹配', 'description' => '注释，分词匹配。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
],
[
'name' => 'Types',
'in' => 'query',
'style' => 'simple',
'schema' => [
'title' => '类型，精确匹配，支持多项，按照逻辑或的关系查询',
'description' => '类型，精确匹配，为空时查询所有类型。',
'type' => 'array',
'items' => ['description' => '数据目录类型。', 'type' => 'string', 'required' => false, 'example' => 'HIVE'],
'required' => false,
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为CreateTime',
'description' => '排序字段，默认为CreateTime，枚举值，当前支持'."\n"
."\n\n"
.'- CreateTime 创建时间'."\n"
.'- ModifyTime 修改时间'."\n"
.'- Name 名称'."\n"
.'- Type 类型',
'type' => 'string',
'required' => false,
'example' => 'CreateTime',
'pattern' => '^[\\w.,;/@-]+$',
'default' => 'CreateTime',
'enum' => ['CreateTime', 'ModifyTime', 'Name', 'Type'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n"
."\n\n"
.'- Asc 升序'."\n"
.'- Desc 降序',
'type' => 'string',
'required' => false,
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100。', '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' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '317CD7D0-AB36-XXXXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页结果',
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Catalogs' => [
'description' => '数据目录列表。',
'type' => 'array',
'items' => ['description' => '数据目录详情。', '$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\\": \\"dlf-catalog:123456XXX:test_catalog\\\\nstarrocks-catalog:c-abc123xxx:default_catalog\\",\\n \\"Name\\": \\"default_catalog\\",\\n \\"Comment\\": \\"this is a comment\\\\n\\",\\n \\"Type\\": \\"Internal\\",\\n \\"CreateTime\\": 1722073854000,\\n \\"ModifyTime\\": 1722073854000,\\n \\"ParentMetaEntityId\\": \\"dlf\\\\nstarrocks:c-abc123xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询数据地图数据目录列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListCatalogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListCertificates' => [
'summary' => '查询认证文件列表。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '250939',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['title' => '证书文件所属项目ID。', 'description' => '证书文件所属项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认值为10，最大值100', 'description' => '分页大小，默认值为10，最大值100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '查询第几页，默认值为1表示第一页', 'description' => '查询第几页，默认值为1表示第一页', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '文件名称，基于此名称做模糊查询', 'description' => '文件名称，基于此名称做模糊查询', 'type' => 'string', 'required' => false, 'example' => 'xm_create_test'],
],
[
'name' => 'CreateUser',
'in' => 'query',
'schema' => ['title' => '查询某个创建者ID所创建的文件列表', 'description' => '查询某个创建者ID所创建的文件列表', 'type' => 'string', 'required' => false, 'example' => '1107550004253538'],
],
[
'name' => 'StartCreateTime',
'in' => 'query',
'schema' => ['title' => '查询创建时间在该日期之后的文件。'."\n"
.'单位：毫秒', 'description' => '查询创建时间在该日期之后的文件。'."\n"
.'单位：毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1730217600000'],
],
[
'name' => 'EndCreateTime',
'in' => 'query',
'schema' => ['title' => '查询创建时间在该日期之前的文件。'."\n"
.'单位：毫秒', 'description' => '查询创建时间在该日期之前的文件。'."\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' => '认证文件列表排序字段，支持名称、创建时间、文件ID排序'."\n"
.'- CreateTime'."\n"
.'- Id'."\n"
.'- Name'."\n"
."\n"
.'默认值：Id', 'type' => 'string', 'required' => false, 'example' => 'Id'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['title' => '认证文件列表排序方向，枚举值：'."\n"
.'● Desc表示倒序'."\n"
.'● Asc表示正序'."\n"
.'默认值：Asc', 'description' => '认证文件列表排序方向，枚举值：'."\n"
.'● Desc表示倒序'."\n"
.'● Asc表示正序'."\n"
.'默认值：Asc', 'type' => 'string', 'required' => false, 'example' => 'Asc'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID，一次请求的唯一标识。', 'type' => 'string', 'example' => 'ecb967ec-c137-48****'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Certificates' => [
'title' => '认证文件列表',
'description' => '认证文件列表',
'type' => 'array',
'items' => [
'description' => '证书列表信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '认证文件ID，即认证文件的唯一标识符', 'type' => 'integer', 'format' => 'int64', 'example' => '676303114031776'],
'Name' => ['description' => '文件名', 'type' => 'string', 'example' => 'ca1.crt'],
'CreateUser' => ['description' => '创建者ID', 'type' => 'string', 'example' => '1107550004253538'],
'CreateTime' => ['description' => '创建时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1730217600000'],
'FileSizeInBytes' => ['description' => '文件字节大小', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'],
'Description' => ['description' => '描述信息', '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' => '查询证书文件列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListColumns' => [
'summary' => '查询数据地图给定数据表的字段列表。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '267999',
'abilityTreeNodes' => ['FEATUREdideE9XYA6'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TableId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['title' => '数据表ID', 'description' => '数据表ID，可参考ListTables接口返回结果，'."\n"
.'以及[元数据实体相关概念说明](~~2880092~~)。', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '名称，模糊匹配', 'description' => '名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test_table'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['title' => '注释，模糊匹配', 'description' => '注释，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test comment'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为CreateTime',
'description' => '排序字段，默认为Position，枚举值，当前支持'."\n"
.'- Name 名称'."\n"
.'- Position 位置',
'type' => 'string',
'required' => false,
'example' => 'Position',
'default' => 'Position',
'enum' => ['Name', 'Position'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n"
.'- Asc 升序'."\n"
.'- Desc 降序',
'type' => 'string',
'required' => false,
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'IncludeExtendedProperties',
'in' => 'query',
'schema' => ['type' => 'boolean'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页结果',
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageNumber' => ['description' => '分页页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Columns' => [
'description' => '字段列表。',
'type' => 'array',
'items' => ['description' => '字段信息。', '$ref' => '#/components/schemas/Column'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询数据地图数据表字段列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListColumns',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Columns\\": [\\n {\\n \\"Id\\": \\"maxcompute-column:::project_name:[schema_name]:table_name:column_name\\",\\n \\"Name\\": \\"column_name\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:::project_name:[schema_name]:table_name\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListComponents' => [
'summary' => '获取组件列表。',
'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' => '数据源关联的工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '数据源的名称。', 'type' => 'string', 'required' => false, 'example' => 'xm_create_test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大为100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题。'."\n", 'type' => 'string', 'example' => '952795279527ab****'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageNumber' => ['description' => '分页页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Components' => [
'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID （阿里云账号创建则直接为阿里云账号ID）。',
'type' => 'array',
'items' => [
'description' => '数据集加速组件的创建者的Uid，在阿里云内为RAM用户ID （阿里云账号创建则直接为阿里云账号ID）。',
'type' => 'object',
'properties' => [
'ModifyTime' => ['description' => '发布流程修改时间戳。', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2023-11-30T13:30:58Z'],
'Script' => [
'title' => '脚本信息',
'description' => '脚本信息',
'type' => 'object',
'properties' => [
'Path' => ['title' => '脚本路径', 'description' => '脚本路径', 'type' => 'string', 'example' => '/', 'pattern' => '', 'default' => ''],
'Runtime' => [
'title' => '运行时',
'description' => '运行时',
'type' => 'object',
'properties' => [
'Command' => ['title' => '命令', 'description' => '命令', 'type' => 'string', 'example' => 'SQL_COMPONENT', 'pattern' => '', 'default' => ''],
],
],
'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '348100'],
],
],
'Owner' => ['title' => '责任人', 'description' => '责任人', 'type' => 'string', 'example' => '252675537980665607', 'pattern' => '', 'default' => ''],
'Description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'vpc peering management_staging', 'pattern' => '', 'default' => ''],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2023-03-13 16:35:59'],
'Outputs' => [
'title' => '输出参数',
'description' => '输出参数',
'type' => 'array',
'items' => [
'description' => '节点输出项',
'type' => 'object',
'properties' => [
'DefaultValue' => ['title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => '32000', 'pattern' => '', 'default' => ''],
'Type' => ['title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'string', 'pattern' => '', 'default' => ''],
'Description' => ['title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => 'zdy', 'pattern' => '', 'default' => ''],
'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'auto_updateAlertRule_test_bULIRo', 'pattern' => '', 'default' => ''],
],
],
],
'ProjectId' => ['description' => 'DataWorks工作空间的ID。您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'example' => '199925'],
'ComponentId' => ['description' => '组件ID。可作为查询导播台组件、修改导播台组件、删除导播台组件的请求参数。', 'type' => 'string', 'example' => '12312313123'],
'Inputs' => [
'title' => '输入参数',
'description' => '输入参数',
'type' => 'array',
'items' => [
'description' => '变量元素',
'type' => 'object',
'properties' => [
'DefaultValue' => ['title' => '默认值', 'description' => '默认值', 'type' => 'string', 'example' => 'mdb.shard.2x.2xlarge.d', 'pattern' => '', 'default' => ''],
'Type' => ['title' => '参数类型', 'description' => '参数类型', 'type' => 'string', 'example' => 'string', 'pattern' => '', 'default' => ''],
'Description' => ['title' => '参数描述', 'description' => '参数描述', 'type' => 'string', 'example' => 'None', 'pattern' => '', 'default' => ''],
'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'auto_updateAlertRule_test_bULIRo', 'pattern' => '', 'default' => ''],
],
],
],
'Name' => ['title' => '资源名称', 'description' => '资源名称', 'type' => 'string', 'example' => 'auto_updateAlertRule_test_lJd81f', 'pattern' => '', 'default' => ''],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取组件列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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"}]',
],
'ListComputeResources' => [
'summary' => '根据计算资源业务信息，查询符合的计算资源列表。',
'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' => 'DataWorks工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21229'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '计算资源的名称。', 'type' => 'string', 'required' => false, 'example' => 'category name '],
],
[
'name' => 'Types',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => '计算资源类型查询过滤，可以配置多个类型查询过滤。',
'type' => 'array',
'items' => ['description' => '计算资源的类型。', 'type' => 'string', 'required' => false, 'example' => 'hologres'],
'required' => false,
],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => ['description' => '计算资源环境类型，枚举值：'."\n"
.'- Dev：开发环境'."\n"
.'- Prod：生产环境', 'type' => 'string', 'required' => false, 'example' => 'Dev'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '查询第几页，默认值为1表示第一页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，默认值为10，最大值100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '计算资源列表排序字段，支持名称、创建时间、计算资源ID排序'."\n"
."\n"
.'- CreateTime：创建时间'."\n"
.'- Id：计算资源ID'."\n"
.'- Name：计算资源名称'."\n"
.'- CreateTimeWithDefaultFirst：基于默认与否和创建时间排序，默认计算资源排序在前'."\n"
."\n"
.'默认值：CreateTime', 'type' => 'string', 'required' => false, 'example' => 'CreateTimeWithDefaultFirst'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '计算资源列表排序方向，枚举值：'."\n"
."\n"
.'- Desc：倒序'."\n"
.'- Asc：正序'."\n"
."\n"
.'默认值：Desc', 'type' => 'string', 'required' => false, 'example' => 'Asc'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ComputeResources' => [
'description' => '计算资源列表，每一个元素是一个计算资源组，包含开发环境（如有）和生产环境的信息。',
'type' => 'array',
'items' => [
'description' => '计算资源组信息，包含开发环境（如有）和生产环境的计算资源。开发环境和生产环境的计算资源具有相同的计算资源名称和计算资源类型，不相同的计算资源ID。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '计算资源的名称。', 'type' => 'string', 'example' => 'cal_all_vemg_workflow_parallel'],
'Type' => ['description' => '计算资源类型。', 'type' => 'string', 'example' => 'hologres'],
'ComputeResource' => [
'description' => '单条计算资源信息。',
'type' => 'array',
'items' => [
'description' => '单条计算资源信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '计算资源ID，计算资源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '8649832502405358603'],
'ConnectionProperties' => ['description' => '计算资源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n"
.'InstanceMode 实例模式。'."\n"
.'UrlMode 连接串模式。', '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' => '计算资源的具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境envType信息是此对象的成员属性，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）'."\n"
.'不同类型的计算资源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范', 'type' => 'string', 'example' => 'UrlMode'],
'Description' => ['description' => '计算资源ID，计算资源的唯一标识符。', 'type' => 'string', 'example' => 'home_feed'],
'CreateTime' => ['description' => '创建时间（时间戳）', 'type' => 'integer', 'format' => 'int64', 'example' => '1624387842781448'],
'CreateUser' => ['description' => '创建者ID。', 'type' => 'string', 'example' => '1648711113000'],
'ModifyTime' => ['description' => '计算资源的最近修改时间（时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1624387842781448'],
'ModifyUser' => ['description' => '计算资源的修改者ID。', 'type' => 'string', 'example' => '1648711113000'],
'WhetherDefault' => ['description' => '是否为默认计算资源', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取计算资源列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'3. 租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListComputeResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'ListCrawlerTypes' => [
'summary' => '查询数据地图支持的元数据采集器类型列表，其中包含元数据采集器类型，及给定类型支持的子类型和子类型之间的层级关系信息。',
'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' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true'],
'CrawlerTypes' => [
'title' => '元数据采集器类型列表',
'description' => '元数据采集器类型列表。',
'type' => 'array',
'items' => ['description' => '支持的元数据采集器类型信息。', '$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' => '获取数据地图元数据采集器类型列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListCrawlerTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListCustomAgents' => [
'summary' => '分页列出 自定义 Agent',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '本次请求返回的最大条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '分页 Token。首次查询不传；后续查询传上一次返回的 `NextToken` 获取下一页。'."\n", 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
'name' => 'Q',
'in' => 'formData',
'schema' => ['description' => '搜索关键词，按 Agent 名称模糊匹配。'."\n", 'type' => 'string', 'required' => false, 'example' => 'analysis'],
],
[
'name' => 'Visibility',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '按可见性级别过滤，可传多个。'."\n",
'type' => 'array',
'items' => [
'description' => '可见性',
'type' => 'string',
'required' => false,
'example' => 'TENANT',
'enum' => ['TENANT', 'PROJECT', 'USER'],
],
'required' => false,
'example' => '-',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '符合条件的总条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'MaxResults' => ['description' => '本次返回的最大条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'NextToken' => ['description' => '下一页 Token，为空表示已到末页。'."\n", 'type' => 'string', 'example' => '5'],
'Agents' => [
'description' => '自定义 Agent 列表。'."\n",
'type' => 'array',
'items' => [
'description' => 'Agent 列表',
'type' => 'object',
'properties' => [
'Name' => ['description' => '**Agent 名称。**'."\n", 'type' => 'string', 'example' => 'my-agent'],
'DisplayName' => ['description' => '**展示名称。**'."\n", 'type' => 'string', 'example' => '我的助手'],
'Description' => ['description' => '**描述。**'."\n", 'type' => 'string', 'example' => '数据分析助手'],
'CreatorId' => ['description' => '**创建者 ID。**'."\n", 'type' => 'string', 'example' => '123456'],
'ModifierId' => ['description' => '**最近修改者 ID。**'."\n", 'type' => 'string', 'example' => '123456'],
'Visibility' => ['description' => '**可见性级别。**'."\n", 'type' => 'string', 'example' => 'TENANT'],
'GmtCreateTime' => ['description' => '**创建时间（毫秒时间戳）。**'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'GmtModifiedTime' => ['description' => '**最近修改时间（毫秒时间戳）。**'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '分页列出 自定义 Agent',
'description' => '## 请求说明'."\n"
."\n"
.'- **搜索关键词**：通过 `Q` 参数可以按 Agent 名称进行模糊匹配。'."\n"
.'- **可见性级别过滤**：使用 `Visibility` 参数可以根据可见性级别（如 `TENANT`、`PROJECT`、`USER`）来过滤结果。'."\n"
.'- **分页信息**：通过 `MaxResults` 和 `NextToken` 参数实现分页查询，其中 `NextToken` 用于获取下一页的数据。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"5\\",\\n \\"Agents\\": [\\n {\\n \\"Name\\": \\"my-agent\\",\\n \\"DisplayName\\": \\"我的助手\\",\\n \\"Description\\": \\"数据分析助手\\",\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListCustomAttributes' => [
'summary' => '查询自定义属性定义列表',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大100', 'description' => '分页大小，默认为10，最大100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['title' => '自定义属性展示名称，按普通文本包含匹配', 'description' => '自定义属性展示名称，按普通文本包含匹配', 'type' => 'string', 'required' => false, 'example' => 'Owner'],
],
[
'name' => 'EntityTypes',
'in' => 'query',
'schema' => ['title' => '自定义属性适用的实体类型，多个实体类型使用英文逗号分隔，例如 `*-table,*-column`。支持具体实体类型（如 hms-table、emr-table）以及通配类型 `*-table`、`*-column`', 'description' => '自定义属性适用的实体类型，多个实体类型使用英文逗号分隔，例如 `*-table,*-column`。支持具体实体类型（如 hms-table、emr-table）以及通配类型 `*-table`、`*-column`', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['title' => '自定义属性描述，模糊匹配', 'description' => '自定义属性描述，模糊匹配', 'type' => 'string', 'required' => false, 'example' => 'owner'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，支持 Name、Type、CreateTime、ModifyTime',
'description' => '排序字段，支持CreateTime、ModifyTime',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ModifyTime' => 'ModifyTime', 'CreateTime' => 'CreateTime'],
'example' => 'CreateTime',
'default' => 'CreateTime',
'enum' => ['Name', 'Type', 'CreateTime', 'ModifyTime'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，支持 Asc、Desc',
'description' => '排序方向，支持 Asc、Desc',
'type' => 'string',
'required' => false,
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '54594ACA-7976-5273-958B-02E15E9B867C'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页信息',
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'CustomAttributes' => [
'title' => '自定义属性定义列表',
'description' => '自定义属性对象列表',
'type' => 'array',
'items' => ['description' => '自定义属性对象', '$ref' => '#/components/schemas/CustomAttribute'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询自定义属性列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54594ACA-7976-5273-958B-02E15E9B867C\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"CustomAttributes\\": [\\n {\\n \\"Id\\": \\"custom-attribute:biz_owner\\",\\n \\"DisplayName\\": \\"业务负责人\\",\\n \\"Type\\": \\"TEXT\\",\\n \\"EntityTypes\\": [\\n \\"maxcompute-table\\"\\n ],\\n \\"ValueEnums\\": [\\n \\"VALUE_1\\"\\n ],\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"Comment\\": \\"this is a comment\\",\\n \\"CreateTime\\": 1750817692000,\\n \\"ModifyTime\\": 1763380628000\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDIAlarmRules' => [
'summary' => '查看数据集成报警规则。',
'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' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000001'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大100条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'DIAlarmRuleId',
'in' => 'query',
'schema' => ['description' => '指定查询特定的告警规则ID，如为空，则查询JobId下的所有告警规则。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '34988'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '74C2FECD-5B3A-554A-BCF5-351A36DE9815'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '90'],
'PageNumber' => ['description' => '分页页码，从1开始。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'DIJobAlarmRules' => [
'description' => '告警规则列表。',
'type' => 'array',
'items' => [
'description' => '单个告警规则详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '72402'],
'DIJobId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '32594'],
'Description' => ['description' => '告警规则描述。', 'type' => 'string', 'example' => 'rule descrition'],
'MetricType' => ['description' => '告警指标类型，可选的枚举值：'."\n"
.'- Heartbeat（任务状态报警）'."\n"
.'- FailoverCount（failover次数报警）'."\n"
.'- Delay（任务延迟报警）'."\n"
.'- DdlReport（DDL通知）'."\n"
.'- ResourceUtilization（资源组使用率）', 'type' => 'string', 'example' => 'Heartbeat'],
'Name' => ['description' => '告警规则名称。', 'type' => 'string', 'example' => 'rule_name'],
'Enabled' => ['description' => '告警规则是否启用。', 'type' => 'boolean', 'example' => 'True'],
'TriggerConditions' => [
'description' => '告警触发条件列表，支持多条件。',
'type' => 'array',
'items' => [
'description' => '告警触发条件。',
'type' => 'object',
'properties' => [
'Severity' => ['description' => '严重程度，可选的枚举值：'."\n"
.'- Warning'."\n"
.'- Critical', 'type' => 'string', 'example' => 'Critical'],
'Duration' => ['description' => '告警计算时间区间，单位分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Threshold' => ['description' => '告警阈值。'."\n"
."\n"
.'- 任务状态报警：无阈值。'."\n"
.'- failover次数报警：阈值为failover次数。'."\n"
.'- 任务延迟报警：阈值为延迟时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'DdlTypes' => [
'description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表。',
'type' => 'array',
'items' => ['description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表，包括'."\n"
."\n"
.'- AlterAddColumn 加列'."\n"
.'- AlterDropColumn 删列'."\n"
.'- AlterRenameColumn 修改列名'."\n"
.'- AlterRenameTable 修改表名'."\n"
.'- AlterTableModify 其他修改表'."\n"
.'- DropTable 删除表'."\n"
.'- TruncateTable 清空表', 'type' => 'string', 'example' => 'AlterAddColumn'],
],
'DdlReportTags' => [
'description' => '该字段已废弃，请使用DdlTypes字段',
'type' => 'array',
'items' => ['description' => '该字段已废弃，请使用DdlTypes字段', 'type' => 'string', 'deprecated' => true, 'example' => 'ALTERADDCOLUMN'],
'deprecated' => true,
],
],
],
],
'NotificationSettings' => [
'description' => '告警通知渠道和接收人设置。',
'type' => 'object',
'properties' => [
'NotificationChannels' => [
'description' => '告警通知渠道数组。',
'type' => 'array',
'items' => [
'description' => '单个告警通知渠道。',
'type' => 'object',
'properties' => [
'Severity' => ['description' => '严重程度，可选的枚举值：'."\n"
.'- Warning'."\n"
.'- Critical', 'type' => 'string', 'example' => 'Critical'],
'Channels' => [
'description' => '告警通道设置数组。',
'type' => 'array',
'items' => ['description' => '通道，可选的枚举值;'."\n"
.'- Mail（邮件）'."\n"
.'- Phone（电话）'."\n"
.'- Sms（短信）'."\n"
.'- Ding（钉钉）', 'type' => 'string', 'example' => 'Ding'],
],
],
],
],
'NotificationReceivers' => [
'description' => '告警通知接收方。',
'type' => 'array',
'items' => [
'description' => '告警通知接收方。',
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl', 'type' => 'string', 'example' => 'DingToken'],
'ReceiverValues' => [
'description' => '接收方取值。'."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。',
'type' => 'array',
'items' => ['description' => '接收方取值。'."\n"
."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', 'type' => 'string', 'example' => 'token1'],
],
],
],
],
'MuteInterval' => ['description' => '告警抑制间隔时长，单位分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'InhibitionInterval' => ['description' => '该字段已废弃，请使用MuteInterval字段', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '5'],
],
],
'DIAlarmRuleId' => ['description' => '该字段已废弃，请使用Id字段。', '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' => '获取数据集成同步任务告警规则列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListDIJobEvents' => [
'summary' => '获取数据集成任务事件。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '235253',
'abilityTreeNodes' => ['FEATUREdideBP0OJZ'],
],
'parameters' => [
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '实例 ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11588'],
],
[
'name' => 'EventType',
'in' => 'query',
'schema' => ['description' => '查询的Event类型，目前支持Failover/Alarm/DDL。', 'type' => 'string', 'required' => true, 'example' => 'Alarm'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '起始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1716971005'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1717971005'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认值为1。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大100条。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '645F6D68-9C29-5961-80B1-BDD4****'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2524'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'DIJobEvent' => [
'description' => '事件的数组',
'type' => 'array',
'items' => [
'description' => '单个事件的详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '事件唯一ID。', 'type' => 'string', 'example' => '1'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '1663573162'],
'FailoverMessage' => ['description' => 'Failover的报错日志。', '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' => '告警严重程度，取值范围：Warning/Critical。', 'type' => 'string', 'example' => 'Warning'],
'Channels' => ['description' => '告警的发送方式，取值范围：Phone/Mail/Sms/Ding/Webhook。', 'type' => 'string', 'example' => 'Phone'],
'Status' => ['description' => '告警的发送状态，取值范围：Success/Fail/Silence。', 'type' => 'string', 'example' => 'Success'],
'Detail' => ['description' => '告警详情。', 'type' => 'string', 'example' => 'Data integration sync task exception: Level: WARNING, DataWorks project name:** [Region: cn-shanghai], Task name:**, Alert rule: Business delay, aggregator:avg [**] for 5 minutes, service maybe abnormal.'],
'Type' => ['description' => '告警事件类型'."\n"
.'- Heartbeat: 任务心跳报警'."\n"
.'- Delay: 任务延迟报警'."\n"
.'- FailoverCount: failover次数报警'."\n"
.'- DdlReport: DDL通知'."\n"
.'- ResourceUtilization： 资源组使用率。', 'type' => 'string', 'example' => 'Delay'],
'Action' => ['description' => 'DDL事件的处理结果，取值范围：Critical/Ignore/Normal/Warning。', 'type' => 'string', 'example' => 'Ignore'],
'SrcTable' => ['description' => '来源表名。', 'type' => 'string', 'example' => 'table1'],
'DstTable' => ['description' => '去向表名。', 'type' => 'string', 'example' => 'table2'],
'SrcSql' => ['description' => '来源表DDL语句。', 'type' => 'string', 'example' => 'alter table table1 ***'],
'DstSql' => ['description' => '去向表DDL语句。', '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\\": \\"Data integration sync task exception: Level: WARNING, DataWorks project name:** [Region: cn-shanghai], Task name:**, Alert rule: Business delay, aggregator:avg [**] for 5 minutes, service maybe abnormal.\\",\\n \\"Type\\": \\"Delay\\",\\n \\"Action\\": \\"Ignore\\",\\n \\"SrcTable\\": \\"table1\\",\\n \\"DstTable\\": \\"table2\\",\\n \\"SrcSql\\": \\"alter table table1 ***\\",\\n \\"DstSql\\": \\"alter table table2 ***\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取数据集成同步任务的运行事件列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListDIJobMetrics' => [
'summary' => '获取数据集成任务指标。',
'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' => '实例 ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11265'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '起始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1586509407'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1712205941'],
],
[
'name' => 'MetricName',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '需要查询的指标列表。',
'type' => 'array',
'items' => ['description' => '需要查询的指标名称，目前支持下面6种指标'."\n"
.'- resourceUtilization: 资源组使用率 （只有在serverless资源组上才支持）'."\n"
.'- delayTime: 任务延迟'."\n"
.'- totalRecordsRead:读端同步条数'."\n"
.'- speedRecordsRead: 读端同步速率'."\n"
.'- totalRecordsWrite:写端同步条数'."\n"
.'- speedRecordsWrite:写端同步速率。', 'type' => 'string', 'required' => false, 'example' => 'delayTime'],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'JobMetrics' => [
'description' => '任务指标列表。',
'type' => 'array',
'items' => [
'description' => '单个指标的信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '查询的指标名称。', 'type' => 'string', 'example' => 'JobDelay'],
'SeriesList' => [
'description' => '具体的指标数组，由一系列不同时间的采样时间和采样值组成。',
'type' => 'array',
'items' => [
'description' => '指标内容。',
'type' => 'object',
'properties' => [
'Time' => ['description' => '采样时间点。', 'type' => 'integer', 'format' => 'int64', 'example' => '1716881141'],
'Value' => ['description' => '样本值。', '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' => '查看数据集成同步任务运行指标',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListDIJobRunDetails' => [
'summary' => '获取数据集成运行信息。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '235254',
'abilityTreeNodes' => ['FEATUREdideBP0OJZ'],
],
'parameters' => [
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11265'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '请求的数据页数，用于翻页。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大100条。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'SourceDataSourceName',
'in' => 'query',
'schema' => ['description' => '筛选的源端数据源名。', 'type' => 'string', 'required' => false, 'example' => 'ds_name'],
],
[
'name' => 'SourceDatabaseName',
'in' => 'query',
'schema' => ['description' => '筛选的源端数据库名。', 'type' => 'string', 'required' => false, 'example' => 'db_name'],
],
[
'name' => 'SourceSchemaName',
'in' => 'query',
'schema' => ['description' => '筛选的源端schema名。', 'type' => 'string', 'required' => false, 'example' => 'schema_name'],
],
[
'name' => 'SourceTableName',
'in' => 'query',
'schema' => ['description' => '筛选的源端表名。', 'type' => 'string', 'required' => false, 'example' => 'table_name'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'string', 'example' => '131'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'string', 'example' => '10'],
'PageNumber' => ['description' => '查询分页的页码。', 'type' => 'string', 'example' => '1'],
'JobRunInfos' => [
'description' => '任务运行信息。',
'type' => 'array',
'items' => [
'description' => '单个表的任务运行信息。',
'type' => 'object',
'properties' => [
'SourceDatasourceName' => ['description' => '源端数据源名。', 'type' => 'string', 'example' => 'ds_name'],
'SourceDatabaseName' => ['description' => '源端数据库名。', 'type' => 'string', 'example' => 'db_name'],
'SourceSchemaName' => ['description' => '源端schema名。', 'type' => 'string', 'example' => 'schema_name'],
'SourceTableName' => ['description' => '源表名。', 'type' => 'string', 'example' => 'table_name'],
'DestinationDatasourceName' => ['description' => '目的端数据源名。', 'type' => 'string', 'example' => 'dst_name'],
'DestinationDatabaseName' => ['description' => '目的端数据库名。', 'type' => 'string', 'example' => 'dst_db'],
'DestinationSchemaName' => ['description' => '目的端Schema名。', 'type' => 'string', 'example' => 'dst_schema'],
'DestinationTableName' => ['description' => '目的端表名。', 'type' => 'string', 'example' => 'dst_name'],
'StructureMigrationStatus' => ['description' => '结构同步状态。', 'type' => 'string', 'example' => 'Finished'],
'StructureMigrationErrorMessage' => ['description' => '结构同步报错信息，如不报错则为空。', 'type' => 'string', 'example' => 'create table t1 fail.'],
'FullMigrationStatus' => ['description' => '全量离线迁移状态。', 'type' => 'string', 'example' => 'Finished'],
'FullMigrationErrorMessage' => ['description' => '全量离线迁移报错信息，如不报错则为空。', 'type' => 'string', 'example' => 'sync table t1 fail.'],
'OfflineErrorRecords' => ['description' => '全量同步总错误数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'OfflineTotalBytes' => ['description' => '全量同步总Bytes数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'OfflineTotalRecords' => ['description' => '全量同步总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'RealtimeMigrationStatus' => ['description' => '实时同步状态。', 'type' => 'string', 'example' => 'Running'],
'RealtimeMigrationErrorMessage' => ['description' => '实时同步错误信息，如不报错则为空', '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' => '获取数据集成同步任务运行的执行进展',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListDIJobs' => [
'summary' => '查询数据集成新版任务列表，包括整库同步实时任务，整库同步离线任务，单表同步实时任务等数据集成任务。',
'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' => '页码，从1开始，默认值为1。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的数据条数，默认为10条，最大为100条。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '导出任务的名称。'."\n"
."\n"
.'名称必须唯一，即当前DataWorks工作空间中不能存在名称重复的导出任务。', 'type' => 'string', 'required' => false, 'example' => 'test_export_01'],
],
[
'name' => 'SourceDataSourceType',
'in' => 'query',
'schema' => ['description' => '源端数据源类型，不填代表不限制，枚举值：PolarDB，MySQL，Kafka，LogHub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SQLServer，Doris，ClickHouse。', 'type' => 'string', 'required' => false, 'example' => 'MySQL'],
],
[
'name' => 'DestinationDataSourceType',
'in' => 'query',
'schema' => ['description' => '目标端数据源类型，不填代表不限制，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，LogHub，StarRocks，DataHub，AnalyticDB_For_MySQL，Kafka，Hive。', 'type' => 'string', 'required' => false, 'example' => 'Hologres'],
],
[
'name' => 'MigrationType',
'in' => 'query',
'schema' => ['description' => '同步类型，可选的枚举值有：'."\n"
.'- FullAndRealtimeIncremental（全量和实时增量）'."\n"
.'- RealtimeIncremental（实时增量）'."\n"
.'- Full（全量）'."\n"
.'- OfflineIncremental（离线增量）'."\n"
.'- FullAndOfflineIncremental（全量+离线增量）', 'type' => 'string', 'required' => false, 'example' => 'FullAndRealtimeIncremental'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '工作空间的ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1967'],
],
[
'name' => 'SpecType',
'in' => 'query',
'schema' => ['title' => '任务配置规范类型。可选FILESPEC、CLASSIC、ALL。FILESPEC：基于结构化 filespec 的新版任务；CLASSIC：传统配置模式的任务；', 'description' => '任务配置规范类型。可选FILESPEC、CLASSIC、ALL。FILESPEC：基于结构化 filespec 的新版任务；CLASSIC：传统配置模式的任务；', 'type' => 'string', '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' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'DIJobs' => [
'description' => '一组数据集成任务',
'type' => 'array',
'items' => [
'description' => '一个数据集成任务',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据集成任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '32599'],
'ProjectId' => ['description' => '任务所在DataWorks空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '26442'],
'JobName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'mysql_to_holo_sync_35197'],
'MigrationType' => ['description' => '同步类型，可选的枚举值有：'."\n"
.'- FullAndRealtimeIncremental（全量和实时增量）'."\n"
.'- RealtimeIncremental（实时增量）'."\n"
.'- Full（全量）'."\n"
.'- OfflineIncremental（离线增量）'."\n"
.'- FullAndOfflineIncremental（全量+离线增量）', 'type' => 'string', 'example' => 'FullAndRealtimeIncremental'],
'SourceDataSourceType' => ['description' => '源端数据源类型，枚举值：PolarDB，MySQL，Kafka，Loghub，Hologres，Oracle，OceanBase，MongoDB，RedShift，Hive，SqlServer，Doris，ClickHouse。', 'type' => 'string', 'example' => 'Mysql'],
'DestinationDataSourceType' => ['description' => '目标端数据源类型，枚举值：Hologres，OSS-HDFS，OSS，MaxCompute，Loghub，STARROCKS，DataHub，ANALYTICDB_FOR_MYSQL，Kafka，Hive。', 'type' => 'string', 'example' => 'Hologres'],
'JobStatus' => ['description' => '同步状态，可选的枚举值：'."\n"
.'- Finished（运行成功已结束）'."\n"
.'- Initialized（初始化完成）'."\n"
.'- Stopped（已停止）'."\n"
.'- Failed（运行失败）'."\n"
.'- Running（运行中）'."\n"
.'- Stopping（停止中）', 'type' => 'string', 'example' => 'Running'],
'DIJobId' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '32599'],
'Owner' => ['title' => '任务责任人', 'type' => 'string'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据集成同步任务配置列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DIJobs\\": [\\n {\\n \\"Id\\": 32599,\\n \\"ProjectId\\": 26442,\\n \\"JobName\\": \\"mysql_to_holo_sync_35197\\",\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": 32599,\\n \\"Owner\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataAssetTags' => [
'summary' => '查询标签列表。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'abilityTreeCode' => '250731',
'abilityTreeNodes' => ['FEATUREdideKQ371B'],
],
'parameters' => [
[
'name' => 'Key',
'in' => 'query',
'schema' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'key1', 'maxLength' => 128, 'minLength' => 1],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => [
'description' => '标签类型。'."\n"
.'- Normal'."\n"
.'- System',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'System'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认值为1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大为100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0bc1ec92159376****'],
'PagingInfo' => [
'description' => '标签列表分查询结果',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '2524'],
'PageSize' => ['description' => '每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DataAssetTags' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签schema定义。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
'Category' => [
'description' => '标签类型。'."\n"
.'- Normal'."\n"
.'- System',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'This is a description'],
'ValueType' => ['description' => '标签值类型。', 'type' => 'string', 'example' => 'String'],
'Values' => [
'description' => '标签值列表。',
'type' => 'array',
'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'v1'],
],
'Managers' => [
'description' => '标签管理员列表。',
'type' => 'array',
'items' => ['description' => '工号', 'type' => 'string', 'example' => '12345'],
],
'ModifyTime' => ['description' => '标签最近的修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1735890003000'],
'CreateTime' => ['description' => '标签的创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1735890003000'],
'CreateUser' => ['description' => '标签创建人。', 'type' => 'string', 'example' => '12345'],
'ModifyUser' => ['description' => '标签最近的修改人。', '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' => '查询标签列表',
'description' => '需要购买DataWorks企业版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-05-19T03:26:56.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListDataAssets' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '253908',
'abilityTreeNodes' => ['FEATUREdideKQ371B'],
],
'parameters' => [
[
'name' => 'Tags',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '数据资产关联的标签列表，基于标签做查询过滤：'."\n"
.'- 多个值之间是“或”的关系，比如`["key1:v1", "key2:v1", "key3:v1"]`底层查询包含任一一个标签的数据资产。'."\n"
.'- 不传递，或者传递为空表示不作tag过滤。',
'type' => 'array',
'items' => [
'description' => '标签K:V结构定义。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '用户输入的自定义标签键。'."\n"
."\n"
.'最多支持64个字符，不能以`dw:`开头，仅支持中英文数字和部分符号`-@#*<>|[]()+=&%$!~`。', 'type' => 'string', 'required' => false, 'example' => 'key', 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value', 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 1,
],
],
[
'name' => 'DataAssetIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '数据资产唯一id列表',
'type' => 'array',
'items' => ['description' => '数据资产唯一id', 'type' => 'string', 'required' => false, 'example' => '7000069357000'],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
[
'name' => 'DataAssetType',
'in' => 'query',
'schema' => [
'description' => '数据资产类型'."\n"
."\n"
.'- 数据表（ACS::DataWorks::Table）'."\n"
."\n"
.'- 调度任务（ACS::DataWorks::Task）',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'ACS::DataWorks::Task',
'enum' => ['ACS::DataWorks::Table', 'ACS::DataWorks::Task'],
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认值为1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大为100条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => [
'description' => '数据资产所属的工作空间环境，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'AssetDomainId',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '1001'],
],
[
'name' => 'CategoryUuid',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => 'cate-xxxxxxxx'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => '资产域名称'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0bc1ec92159376'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DataAssets' => [
'description' => '数据资产列表。',
'type' => 'array',
'items' => [
'description' => '数据资产Schema定义。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据资产id。', 'type' => 'string', 'example' => '7259557313'],
'Name' => ['description' => '数据资产的名称。', 'type' => 'string', 'example' => 'ali_cn_es_gfn'],
'Type' => [
'description' => '数据资产类型'."\n"
."\n"
.'- 数据表（ACS::DataWorks::Table）'."\n"
."\n"
.'- 调度任务（ACS::DataWorks::Task）',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'ACS::DataWorks::Task',
],
'EnvType' => [
'description' => '数据资产所属的工作空间环境，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Prod',
],
'ProjectId' => ['description' => 'Dataworks工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '54275'],
'DataAssetTagMappings' => [
'description' => '数据资产管理的标签列表。',
'type' => 'array',
'items' => [
'description' => '数据资产和标签映射关系Schema定义。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value'],
'TagSource' => [
'description' => '数据资产和标签关系的来源：'."\n"
."\n"
.'- System：来源于数据资产治理系统的操作'."\n"
.'- UserDefined：来源于用户手动自定义',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'UserDefined',
],
'Creator' => ['description' => '数据资产和标签映射关系的创建者。', 'type' => 'string', 'example' => '12345'],
'AutoTraceEnabled' => ['description' => '是否开启血缘自动回溯。', 'type' => 'boolean', 'example' => 'false'],
'DataAssetId' => ['description' => '数据资产id', 'type' => 'string', 'example' => '7259557313'],
],
],
],
'AssetCategories' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['type' => 'string', 'example' => 'cate-xxxxxx'],
'Name' => ['type' => 'string', 'example' => '资产域名称'],
'AssetDomainId' => ['type' => 'string', 'example' => '1001'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询已关联标签的资产列表',
'summary' => '分页查询已关联标签的DataWorks数据资产。',
'description' => '需要购买DataWorks企业版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-05-19T03:26:56.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataAssets\\": [\\n {\\n \\"Id\\": \\"7259557313\\",\\n \\"Name\\": \\"ali_cn_es_gfn\\",\\n \\"Type\\": \\"ACS::DataWorks::Task\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"ProjectId\\": 54275,\\n \\"DataAssetTagMappings\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"TagSource\\": \\"UserDefined\\",\\n \\"Creator\\": \\"12345\\",\\n \\"AutoTraceEnabled\\": false,\\n \\"DataAssetId\\": \\"7259557313\\"\\n }\\n ],\\n \\"AssetCategories\\": [\\n {\\n \\"Id\\": \\"cate-xxxxxx\\",\\n \\"Name\\": \\"资产域名称\\",\\n \\"AssetDomainId\\": \\"1001\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityAlertRules' => [
'summary' => '查询指定项目下的数据质量告警规则列表。',
'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' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'DataQualityScanId',
'in' => 'query',
'schema' => ['description' => '数据质量告警规则关注的数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认Asc，可以省略）。排序字段的枚举值如下：'."\n"
."\n"
.'- CreateTime (Desc/Asc)'."\n"
.'- Id (Desc/Asc)', 'type' => 'string', 'required' => false, 'example' => 'CreateTime Desc'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '结果分页页码。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '结果分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'PageInfo' => [
'description' => '告警规则配置。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '335'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '数据分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DataQualityAlertRules' => [
'description' => '告警规则配置列表。',
'type' => 'array',
'items' => [
'description' => '告警规则配置。',
'type' => 'object',
'properties' => [
'Condition' => ['description' => '数据质量监控告警规则告警条件。', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }'],
'Target' => [
'description' => '数据质量监控告警规则关注目标。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象的类型，只支持 DataQualityScan。', 'type' => 'string', 'example' => 'DataQualityScan'],
'Ids' => [
'description' => '监控目标ID列表。',
'type' => 'array',
'items' => ['description' => '监控目标ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '7638999336'],
],
],
],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '59094'],
'Id' => ['description' => '数据质量监控告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '26433'],
'Notification' => [
'description' => '告警通知配置。',
'type' => 'object',
'properties' => [
'Receivers' => [
'description' => '告警接收对象。',
'type' => 'array',
'items' => [
'description' => '告警接收对象。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 `{"atAll":true}` @所有人。', 'type' => 'string', 'example' => '{"atAll":true}'],
'ReceiverType' => [
'description' => '告警接收对象类型。'."\n"
.'- ShiftSchedule'."\n"
.'- WebhookUrl'."\n"
.'- FeishuUrl'."\n"
.'- TaskOwner'."\n"
.'- WeixinUrl'."\n"
.'- DingdingUrl'."\n"
.'- DataQualityScanOwner'."\n"
.'- AliUid',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'AliUid',
],
'ReceiverValues' => [
'description' => '告警接收对象值。',
'type' => 'array',
'items' => ['description' => '告警接收对象值。'."\n"
.'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n"
.'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n"
.'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******'],
],
],
],
],
'Channels' => [
'description' => 'Channels中，除可以同时设置Email和Sms外，其他的情况都只能设置一种渠道。',
'type' => 'array',
'items' => [
'description' => '告警通道。'."\n"
.'- Mail'."\n"
.'- Weixin'."\n"
.'- Feishu'."\n"
.'- Phone'."\n"
.'- Sms'."\n"
.'- Webhook',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Sms',
],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '数据质量告警规则列表查询',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityAlertRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 335,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataQualityAlertRules\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 7638999336\\n ]\\n },\\n \\"ProjectId\\": 59094,\\n \\"Id\\": 26433,\\n \\"Notification\\": {\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ],\\n \\"Channels\\": [\\n \\"Sms\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityEvaluationTaskInstances' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '240385',
'abilityTreeNodes' => ['FEATUREdideGK4B66'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'DataQualityEvaluationTaskId',
'in' => 'query',
'schema' => ['description' => '数据质量校验任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'TableGuid',
'in' => 'query',
'schema' => ['description' => '表在数据地图中的唯一ID', 'type' => 'string', 'required' => false, 'example' => 'odps.unit_test.tb_unit_test'],
],
[
'name' => 'CreateTimeFrom',
'in' => 'query',
'schema' => ['description' => '数据质量校验任务实例最早开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'CreateTimeTo',
'in' => 'query',
'schema' => ['description' => '数据质量校验任务实例最晚开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'BizdateFrom',
'in' => 'query',
'schema' => ['description' => '质量校验任务业务起始日期', 'type' => 'string', 'required' => false, 'example' => '2024-04-01'],
],
[
'name' => 'BizdateTo',
'in' => 'query',
'schema' => ['description' => '质量校验任务业务截止日期', 'type' => 'string', 'required' => false, 'example' => '2024-05-01'],
],
[
'name' => 'TriggerClientId',
'in' => 'query',
'schema' => ['description' => 'TriggerContext中的TriggerClientId', 'type' => 'string', 'required' => false, 'example' => '1001'],
],
[
'name' => 'TriggerClient',
'in' => 'query',
'schema' => ['description' => 'TriggerContext中的TriggerClient', 'type' => 'string', 'required' => false, 'example' => 'CWF2'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '列表分页查询页大小，默认为10', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '列表分页查询页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PaginatedModel',
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', 'description' => 'API请求ID', 'type' => 'string', 'example' => '691CA452-D37A-4ED****'],
'PagingInfo' => [
'description' => '质量校验任务实例分页查询结果',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '294'],
'DataQualityEvaluationTaskInstances' => [
'description' => '被触发成功的TaskInstance',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '质检任务实例ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'],
'CreateTime' => ['description' => '任务实例创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishTime' => ['description' => '任务实例结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Status' => ['description' => '当前运行状态'."\n"
.'- Running'."\n"
.'- Error'."\n"
.'- Passed'."\n"
.'- Warned'."\n"
.'- Critical', 'type' => 'string', 'example' => 'Critical'],
'Parameters' => ['description' => '实际运行时，使用的参数设置', 'type' => 'string', 'example' => '{'."\n"
.' "bizdate": "20240517",'."\n"
.' "triggerTime": "1710239005403"'."\n"
.'}'],
'TriggerContext' => ['description' => '实例触发时的上下文信息', 'type' => 'string', 'example' => '{'."\n"
.' "TriggerClientId": 10001,'."\n"
.' "TriggerClient": "CWF2"'."\n"
.'}'],
'ProjectId' => ['description' => 'DataWorks项目空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Task' => [
'description' => '校验开始时，数据质量校验任务的快照',
'type' => 'object',
'properties' => [
'Id' => ['title' => '资源一级ID', 'description' => '数据质量校验任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'],
'Description' => ['title' => '质量监控任务描述', 'description' => '质量监控任务描述', 'type' => 'string', 'example' => 'This is a daily run data quality evaluation plan.'],
'ProjectId' => ['title' => '项目空间Id', 'description' => '项目空间Id', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '100'],
'Target' => [
'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget',
'description' => '数据质量校验任务的监控对象',
'type' => 'object',
'properties' => [
'Type' => ['title' => '监控对象类型', 'description' => '监控对象类型'."\n"
.'- Table', 'type' => 'string', 'example' => 'Table'],
'DatabaseType' => ['title' => '表所属的数据库类型', 'description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'type' => 'string', 'example' => 'maxcompute'],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test'],
'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => '分区表的分区设置', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]'],
],
],
'Trigger' => [
'title' => '数据质量校验任务的触发配置',
'description' => '数据质量校验任务的触发配置',
'type' => 'object',
'properties' => [
'Type' => ['title' => '质量监控任务触发类型', 'description' => '何种事件可以触发质量校验任务执行'."\n"
.'- ByScheduledTaskInstance：调度实例运行成功', 'type' => 'string', 'example' => 'ByScheduledTaskInstance'],
'TaskIds' => [
'title' => '调度任务Ids',
'description' => '调度任务节点IDs',
'type' => 'array',
'items' => ['description' => '调度任务节点ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
],
],
],
'RuntimeConf' => ['title' => '扩展配置', 'description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'],
'Hooks' => [
'title' => '回调设置',
'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['title' => 'Hook类型', 'description' => '后续处理动作类型'."\n"
.'- BlockTaskInstance：阻塞DataWorks任务实例执行', 'type' => 'string', 'example' => 'BlockTaskInstance'],
'Condition' => ['title' => 'Hook触发条件', 'description' => 'Hook触发条件', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"'],
],
'description' => 'Hook',
],
],
'Notifications' => [
'title' => '通知订阅配置',
'description' => '通知订阅配置',
'type' => 'object',
'properties' => [
'Condition' => ['title' => '通知触发条件', 'description' => '通知触发条件', 'type' => 'string', 'example' => '${severity} == "High"'],
'Notifications' => [
'title' => '通知设置',
'description' => '通知设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NofiticationReceivers' => [
'title' => '告警接收人设置',
'description' => '告警接收人设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => ['title' => '告警接收人类型', 'description' => '告警接收人类型'."\n"
.'- AliUid - 阿里云账号Uid'."\n"
.'- WebhookUrl - 自定义 webhook URL'."\n"
.'- DingdingUrl - 钉钉机器人Url'."\n"
.'- FeishuUrl - 飞书机器人Url'."\n"
.'- WeixinUrl - 企微机器人Url', 'type' => 'string', 'example' => 'AliUid'],
'Extension' => ['title' => '扩展信息', 'description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'type' => 'string', 'example' => '{"atAll":"true"}'],
'ReceiverValues' => [
'title' => '告警接收人',
'description' => '告警接收人',
'type' => 'array',
'items' => ['description' => '告警接收人具体值', 'type' => 'string', 'example' => '10000001'],
],
],
'description' => '告警接收人设置',
],
],
'NotificationChannels' => [
'title' => '通知方式',
'description' => '告警方式',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Channels' => [
'title' => '通知方式',
'description' => '告警方式',
'type' => 'array',
'items' => ['description' => '- Mail - 邮件'."\n"
.'- Sms - 短信'."\n"
.'- Phone - 电话'."\n"
.'- Feishu - 飞书'."\n"
.'- Weixin - 微信'."\n"
.'- Dingding - 钉钉'."\n"
.'- Webhook - 自定义Webhook', 'type' => 'string', 'example' => 'Mail'],
],
],
'description' => '通知方式',
],
'deprecated' => false,
],
],
'description' => '通知设置',
],
],
],
],
'Name' => ['title' => '质量监控任务名称', 'description' => '质量监控任务名称', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'Quality verification task'],
],
],
],
'description' => '',
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScanRuns'],
],
'title' => '查询质量监控任务实例列表',
'summary' => '质量监控任务实例列表分页查询。',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-06T02:56:45.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityEvaluationTaskInstances\\": [\\n {\\n \\"Id\\": 10001,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Critical\\",\\n \\"Parameters\\": \\"{\\\\n \\\\\\"bizdate\\\\\\": \\\\\\"20240517\\\\\\",\\\\n \\\\\\"triggerTime\\\\\\": \\\\\\"1710239005403\\\\\\"\\\\n}\\",\\n \\"TriggerContext\\": \\"{\\\\n \\\\\\"TriggerClientId\\\\\\": 10001,\\\\n \\\\\\"TriggerClient\\\\\\": \\\\\\"CWF2\\\\\\"\\\\n}\\",\\n \\"ProjectId\\": 100,\\n \\"Task\\": {\\n \\"Id\\": 10001,\\n \\"Description\\": \\"This is a daily run data quality evaluation plan.\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10000\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NofiticationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"ReceiverValues\\": [\\n \\"10000001\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Name\\": \\"Quality verification task\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityEvaluationTasks' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '240369',
'abilityTreeNodes' => ['FEATUREdideGK4B66'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'TableGuid',
'in' => 'query',
'schema' => ['description' => '表在数据地图中的唯一ID', 'type' => 'string', 'required' => false, 'example' => 'odps.unit_test.tb_unit_test'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '模糊匹配数据质量校验任务名称', 'type' => 'string', 'required' => false, 'example' => 'Test'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '列表分页查询页大小，默认为10', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '列表分页查询页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PaginatedModel',
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', 'description' => 'API请求ID', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-****'],
'PagingInfo' => [
'description' => '质量校验任务分页查询结果',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数', 'type' => 'string', 'example' => '131'],
'PageSize' => ['description' => '页大小', 'type' => 'string', 'example' => '10', 'default' => '10'],
'PageNumber' => ['description' => '页码', 'type' => 'string', 'example' => '1', 'default' => '1'],
'DataQualityEvaluationTasks' => [
'description' => '质量校验任务',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据质量校验任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'],
'Name' => ['description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。', 'type' => 'string', 'example' => 'Data quality verification task'],
'Description' => ['description' => '数据质量校验任务描述，最长65535个字符', 'type' => 'string', 'example' => 'This is a daily run data quality evaluation plan'],
'ProjectId' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Target' => [
'description' => '数据质量校验任务的监控对象',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型'."\n"
."\n"
.'- Table', 'type' => 'string', 'example' => 'Table'],
'DatabaseType' => ['description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'type' => 'string', 'example' => 'maxcompute'],
'TableGuid' => ['description' => '表在数据地图中的唯一ID', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test'],
'PartitionSpec' => ['description' => '分区表的分区设置', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]'],
],
],
'Trigger' => [
'description' => '数据质量校验任务的触发配置',
'type' => 'object',
'properties' => [
'Type' => ['description' => '何种事件可以触发质量校验任务执行'."\n"
."\n"
.'- ByScheduledTaskInstance：调度实例运行成功', 'type' => 'string', 'example' => 'ByScheduledTaskInstance'],
'TaskIds' => [
'description' => 'type=ByScheduledTaskInstance时生效'."\n"
.',具体指明哪些调度节点的实例执行成功后可以触发',
'type' => 'array',
'items' => ['description' => '调度任务节点ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'],
],
],
],
'RuntimeConf' => ['description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'],
'Hooks' => [
'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook',
'type' => 'array',
'items' => [
'description' => '回调设置',
'type' => 'object',
'properties' => [
'Type' => ['description' => '后续处理动作类型'."\n"
.'- BlockTaskInstance：阻塞DataWorks任务实例执行', 'type' => 'string', 'example' => 'BlockTaskInstance'],
'Condition' => ['description' => 'Hook触发条件', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"'],
],
],
],
'Notifications' => [
'description' => '告警配置',
'type' => 'object',
'properties' => [
'Condition' => ['description' => 'Notification触发条件', 'type' => 'string', 'example' => '${severity} == "High"'],
'Notifications' => [
'description' => '具体的告警设置',
'type' => 'array',
'items' => [
'description' => '告警设置',
'type' => 'object',
'properties' => [
'NotificationChannels' => [
'description' => '告警方式配置',
'type' => 'array',
'items' => [
'description' => '告警方式',
'type' => 'object',
'properties' => [
'Channels' => [
'description' => '告警方式',
'type' => 'array',
'items' => ['description' => '告警方式'."\n"
.'- Mail - 邮件'."\n"
.'- Sms - 短信'."\n"
.'- Phone - 电话'."\n"
.'- Feishu - 飞书'."\n"
.'- Weixin - 微信'."\n"
.'- Dingding - 钉钉'."\n"
.'- Webhook - 自定义Webhook', 'type' => 'string', 'example' => 'Mail'],
],
],
],
],
'NotificationReceivers' => [
'description' => '告警接收人配置',
'type' => 'array',
'items' => [
'description' => '告警接收人',
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '告警接收人类型'."\n"
.'- AliUid - 阿里云账号Uid'."\n"
.'- WebhookUrl - 自定义 webhook URL'."\n"
.'- DingdingUrl - 钉钉机器人Url'."\n"
.'- FeishuUrl - 飞书机器人Url'."\n"
.'- WeixinUrl - 企微机器人Url', 'type' => 'string', 'example' => 'AliUid'],
'ReceiverValues' => [
'description' => '告警接收人具体值',
'type' => 'array',
'items' => ['description' => '告警接收人具体值', 'type' => 'string', 'example' => 'user1'],
],
'Extension' => ['description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'type' => 'string', 'example' => '{"atAll":"true"}'],
],
],
],
],
],
],
],
],
'DataSourceId' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
],
'description' => '',
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScans'],
],
'title' => '查询质量监控任务列表',
'summary' => '质量监控任务列表分页查询。',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-06T02:56:45.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"131\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DataQualityEvaluationTasks\\": [\\n {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"Data quality verification task\\",\\n \\"Description\\": \\"This is a daily run data quality evaluation plan\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"user1\\"\\n ],\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityResults' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '240397',
'abilityTreeNodes' => ['FEATUREdideGK4B66'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'DataQualityRuleId',
'in' => 'query',
'schema' => ['description' => '数据质量规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001'],
],
[
'name' => 'DataQualityEvaluationTaskId',
'in' => 'query',
'schema' => ['description' => '数据质量校验任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200001'],
],
[
'name' => 'DataQualityEvaluationTaskInstanceId',
'in' => 'query',
'schema' => ['description' => '数据质量校验任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'],
],
[
'name' => 'CreateTimeFrom',
'in' => 'query',
'schema' => ['description' => '数据质量校验结果最早生成时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'CreateTimeTo',
'in' => 'query',
'schema' => ['description' => '数据质量校验结果最晚生成时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'BizdateFrom',
'in' => 'query',
'schema' => ['description' => '规则实例业务起始日期。', 'type' => 'string', 'required' => false, 'example' => '2024-05-01'],
],
[
'name' => 'BizdateTo',
'in' => 'query',
'schema' => ['description' => '规则实例业务截止日期。', 'type' => 'string', 'required' => false, 'example' => '2024-05-04'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '列表分页查询页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '列表分页查询页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PaginatedModel',
'description' => '返回值。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', 'description' => 'API请求ID。', 'type' => 'string', 'example' => '691CA452-D37A-****'],
'PagingInfo' => [
'description' => '数据质量校验结果分页查询结果。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '219'],
'DataQualityResults' => [
'description' => '质量校验结果列表。',
'type' => 'array',
'items' => [
'description' => '质量校验结果。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '校验结果ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16033'],
'Status' => ['description' => '校验结果状态：'."\n"
.'- Running'."\n"
.'- Error'."\n"
.'- Passed'."\n"
.'- Warned'."\n"
.'- Critical', 'type' => 'string', 'example' => 'Passed'],
'CreateTime' => ['description' => '校验结果生成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1708284916414'],
'TaskInstanceId' => ['description' => '校验任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '200001'],
'Sample' => ['description' => '本次校验所使用的样本值。', 'type' => 'string', 'example' => '['."\n"
.' {'."\n"
.' "gender": "male",'."\n"
.' "_count": 100'."\n"
.' }, {'."\n"
.' "gender": "female",'."\n"
.' "_count": 100'."\n"
.' }'."\n"
.']'],
'Details' => [
'description' => '本次校验的详情。',
'type' => 'array',
'items' => [
'description' => '校验详情。',
'type' => 'object',
'properties' => [
'ReferencedValue' => ['description' => '使用引用的样本，用来参与CheckedValue计算的基准值。', 'type' => 'string', 'example' => '0.0'],
'CheckedValue' => ['description' => '最终用来与阈值比较的值。', 'type' => 'string', 'example' => '100.0'],
'Status' => ['description' => '最终的比较结果状态：'."\n"
.'- Error'."\n"
.'- Passed'."\n"
.'- Warned'."\n"
.'- Critical', 'type' => 'string', 'example' => 'Passed'],
],
],
],
'Rule' => [
'description' => '校验开始时，规则配置快照。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100001'],
'Name' => ['description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。', 'type' => 'string', 'example' => 'The table cannot be empty.'],
'ProjectId' => ['description' => 'DataWorks项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Enabled' => ['description' => '规则是否启用。', 'type' => 'boolean', 'example' => 'true'],
'Severity' => ['description' => '规则对于业务的等级（对应页面上的强弱规则）：'."\n"
.'- High'."\n"
.'- Normal', 'type' => 'string', 'example' => 'Normal'],
'Description' => ['description' => '规则描述信息，最长500个字符。', 'type' => 'string', 'example' => 'this is a odps _sql task'],
'TemplateCode' => ['description' => '创建规则时所引用的规则模板Code。', 'type' => 'string', 'example' => 'SYSTEM:user_defined_sql'],
'Target' => [
'description' => '规则所监控的对象。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型：'."\n"
.'- Table', 'type' => 'string', 'example' => 'Table'],
'DatabaseType' => ['description' => '表类型的数据集，表所属的数据库类型：'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'type' => 'string', 'example' => 'maxcompute'],
'TableGuid' => ['description' => '表在数据地图中的唯一ID。', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test'],
],
],
'SamplingConfig' => [
'description' => '样本采集所需的设置。',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称：'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'example' => 'Count'],
'MetricParameters' => ['description' => '样本采集时，所需的参数。', 'type' => 'string', 'example' => '{ "columns": [ "id", "name" ] }'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '],
'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符。', 'type' => 'string', 'example' => 'id IS NULL'],
],
],
'CheckingConfig' => [
'description' => '样本校验设置。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式：'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'],
'Thresholds' => [
'description' => '阈值设置。',
'type' => 'object',
'properties' => [
'Expected' => [
'description' => '期望的阈值设置。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0'],
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'example' => '$checkValue > 0.01'],
],
],
'Warned' => [
'description' => '普通警告的阈值设置。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0'],
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'example' => ' $checkValue > 0.01'],
],
],
'Critical' => [
'description' => '严重警告的阈值设置。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0'],
'Operator' => ['description' => '比较符：'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'example' => ' $checkValue > 0.01'],
],
],
],
],
],
],
'ErrorHandlers' => [
'description' => '质量规则校验问题处理器。',
'type' => 'array',
'items' => [
'description' => '质量规则校验问题处理器。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '处理器类型。'."\n"
.'- SaveErrorData', 'type' => 'string', 'example' => 'SaveErrorData'."\n"],
'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScanRuns'],
],
'title' => '查询质量结果列表',
'summary' => '质量结果列表分页查询。',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-06T02:56:45.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 219,\\n \\"DataQualityResults\\": [\\n {\\n \\"Id\\": 16033,\\n \\"Status\\": \\"Passed\\",\\n \\"CreateTime\\": 1708284916414,\\n \\"TaskInstanceId\\": 200001,\\n \\"Sample\\": \\"[\\\\n {\\\\n \\\\\\"gender\\\\\\": \\\\\\"male\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }, {\\\\n \\\\\\"gender\\\\\\": \\\\\\"female\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }\\\\n]\\",\\n \\"Details\\": [\\n {\\n \\"ReferencedValue\\": \\"0.0\\",\\n \\"CheckedValue\\": \\"100.0\\",\\n \\"Status\\": \\"Passed\\"\\n }\\n ],\\n \\"Rule\\": {\\n \\"Id\\": 100001,\\n \\"Name\\": \\"The table cannot be empty.\\",\\n \\"ProjectId\\": 100,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"Normal\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Count\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] }\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityRuleTemplates' => [
'summary' => '查询质量规则模版列表。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '259074',
'abilityTreeNodes' => ['FEATUREdideRGVRPF'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'],
],
[
'name' => 'CreationSource',
'in' => 'query',
'schema' => ['description' => '规则模板的创建来源，必填。'."\n"
.'- System：系统模板'."\n"
.'- UserDefined：用户自定义模板', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'System'."\n"],
],
[
'name' => 'DirectoryPath',
'in' => 'query',
'schema' => ['description' => '自定义模板被存放的类目目录，斜线/分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含反斜线', 'type' => 'string', 'required' => false, 'example' => '/ods/order_data'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '模板规则名称模糊匹配，如果是系统模板，则会根据语言模糊匹配系统模板的国际化名称', 'type' => 'string', 'required' => false, 'example' => 'Table rows'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '列表分页查询页大小，默认为10', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '10', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '列表分页查询页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID', 'type' => 'string', 'example' => '691CA452-D37A-****'],
'PagingInfo' => [
'description' => '质量规则模版分页查询结果',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '42'],
'PageSize' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DataQualityRuleTemplates' => [
'description' => '规则模版列表',
'type' => 'array',
'items' => [
'description' => '规则模版详情',
'type' => 'object',
'properties' => [
'Code' => ['description' => '规则模版Code', 'type' => 'string', 'example' => 'USER_DEFINED:123'],
'Name' => ['description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符', 'type' => 'string', 'example' => 'Table row Count Verification'."\n"],
'ProjectId' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2043'],
'SamplingConfig' => [
'description' => '样本采集所需的设置',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'example' => 'Max'],
'MetricParameters' => ['description' => '样本采集时，所需的参数', 'type' => 'string', 'example' => '{"Sql": "select count(1) from table;"}'."\n"],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n"
.'SET odps.sql.python.version=cp27;'."\n"],
],
],
'CheckingConfig' => [
'description' => '样本校验设置',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n"],
],
],
'VisibleScope' => ['description' => '模板的可用范围：'."\n"
.'- Tenant：全租户都可用'."\n"
.'- Project：只在当前项目中可用', 'type' => 'string', 'example' => 'Project'],
'DirectoryPath' => ['description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线', 'type' => 'string', 'example' => '/ods/order_data'],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityTemplates'],
'returnType' => 'synchronous',
],
'title' => '查询质量规则模版列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 42,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityRuleTemplates\\": [\\n {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\\\n\\",\\n \\"ProjectId\\": 2043,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"Sql\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\\\n\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityRules' => [
'summary' => '质量监控规则分页查询。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '237677',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['title' => '项目id', 'description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10002'],
],
[
'name' => 'DataQualityEvaluationTaskId',
'in' => 'query',
'schema' => ['title' => '关联的质量校验任务ID', 'description' => '关联的质量校验任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'TableGuid',
'in' => 'query',
'schema' => ['title' => '规则所作用的表在数据地图中的唯一标识', 'description' => '规则所作用的表在数据地图中的唯一标识', 'type' => 'string', 'required' => false, 'example' => 'odps.unit_test.tb_unit_test'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '模糊匹配规则名称', 'description' => '模糊匹配规则名称', 'type' => 'string', 'required' => false, 'example' => 'unit_test'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大为200条', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PaginatedModel',
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', 'description' => 'API请求ID', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'],
'PagingInfo' => [
'description' => '规则列表分查询结果',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '294'],
'DataQualityRules' => [
'description' => '具体的规则列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '22130'],
'Name' => ['description' => '规则名称', 'type' => 'string', 'example' => 'The table cannot be empty.'],
'ProjectId' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100001'],
'Enabled' => ['description' => '质量规则是否启用', 'type' => 'boolean', 'example' => 'true'],
'Severity' => ['description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n"
.'- Normal'."\n"
.'- High', 'type' => 'string', 'example' => 'High'],
'Description' => ['description' => '规则描述信息，最长500个字符', 'type' => 'string', 'example' => 'this is a odps _sql task'],
'Target' => [
'description' => '规则所监控的对象',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型'."\n"
."\n"
.'- Table', 'type' => 'string', 'example' => 'Table'],
'DatabaseType' => ['description' => '表类型的数据集，表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- emr'."\n"
.'- cdh'."\n"
.'- hologres'."\n"
.'- analyticdb_for_postgresql'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks', 'type' => 'string', 'example' => 'maxcompute'],
'TableGuid' => ['description' => '规则所作用的表在数据地图中的唯一ID', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test'],
],
],
'TemplateCode' => ['description' => '规则所引用的规则模板唯一标识', 'type' => 'string', 'example' => 'SYSTEM:user_defined_sql'],
'SamplingConfig' => [
'description' => '样本采集所需的设置',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'example' => 'Max'],
'MetricParameters' => ['description' => '样本采集时，所需的参数', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n"
.'SET odps.sql.python.version=cp27;'],
'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'type' => 'string', 'example' => 'id IS NULL'],
],
],
'CheckingConfig' => [
'description' => '样本校验设置',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'],
'Thresholds' => [
'description' => '阈值设置',
'type' => 'object',
'properties' => [
'Expected' => [
'description' => '期望的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'example' => '$checkValue > 0.01'],
],
],
'Warned' => [
'description' => '普通警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'example' => '$checkValue > 0.01'],
],
],
'Critical' => [
'description' => '严重警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'example' => '>'],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'example' => '$checkValue > 0.01'],
],
],
],
],
],
],
'ErrorHandlers' => [
'description' => '质量规则校验问题处理器列表',
'type' => 'array',
'items' => [
'description' => '质量规则校验问题处理器',
'type' => 'object',
'properties' => [
'Type' => ['description' => '处理器类型：'."\n"
.'- SaveErrorData', 'type' => 'string', 'example' => 'SaveErrorData'."\n"],
'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'],
],
],
],
],
'description' => '',
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScans'],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityRules\\": [\\n {\\n \\"Id\\": 22130,\\n \\"Name\\": \\"The table cannot be empty.\\",\\n \\"ProjectId\\": 100001,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询质量规则列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'extraInfo' => '规则模版Code列表：'."\n"
.'- 自定义SQL：SYSTEM:user_defined_sql'."\n"
."\n"
.'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n"
.'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n"
.'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n"
.'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n"
.'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n"
.'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n"
.'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n"
.'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n"
.'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n"
.'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n"
.'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n"
.'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n"
.'- 表行数，自定义范围：SYSTEM:table:count'."\n"
.'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n"
."\n"
.'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n"
.'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n"
.'- 平均值，自定义范围：SYSTEM:field:avg'."\n"
."\n"
.'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n"
.'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n"
.'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n"
.'- 汇总值，自定义范围：SYSTEM:field:sum'."\n"
."\n"
.'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n"
.'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n"
.'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n"
.'- 最小值，自定义范围：SYSTEM:field:min'."\n"
."\n"
.'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n"
.'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n"
.'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n"
.'- 最大值，自定义范围：SYSTEM:field:max'."\n"
."\n"
.'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n"
.'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n"
.'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n"
."\n"
.'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n"
.'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n"
.'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n"
.'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n"
."\n"
.'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n"
.'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n"
.'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n"
.'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n"
."\n"
.'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n"
.'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n"
.'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n"
.'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n"
.'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n"
.'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n"
."\n"
.'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n"
.'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n"
.'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n"
."\n"
.'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n"
.'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n"
.'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n"
.'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n"
.'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-04T03:12:44.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-06T02:56:45.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListDataQualityScanRuns' => [
'summary' => '查询指定项目下的数据质量扫描运行记录。',
'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' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'],
],
[
'name' => 'CreateTimeFrom',
'in' => 'query',
'schema' => ['description' => '数据质量监控运行最早开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'CreateTimeTo',
'in' => 'query',
'schema' => ['description' => '数据质量监控运行最晚开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '数据质量校验结果状态。'."\n"
.'- Pass'."\n"
.'- Running'."\n"
.'- Error'."\n"
.'- Fail'."\n"
.'- Warn',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Fail',
'enum' => ['Error', 'Fail', 'Kill', 'Pass', 'Running', 'Warn'],
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认Asc，可以省略）。排序字段的枚举值如下：'."\n"
.'- CreateTime (Desc/Asc)'."\n"
.'- Id (Desc/Asc)', 'type' => 'string', 'required' => false, 'example' => 'CreateTime Desc'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '列表翻页查询页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '列表翻页查询页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => '扩展的查询Filter，目前支持以下过滤参数：'."\n"
.'- TaskInstanceId 调度任务实例ID'."\n"
.'- RunNumber 实例运行次数', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
.' "TaskInstanceId": "111",'."\n"
.' "RunNumber": "1"'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'PageInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '324'],
'PageSize' => ['description' => '列表翻页查询页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '列表翻页查询页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DataQualityScanRuns' => [
'description' => '数据质量监控运行记录列表。',
'type' => 'array',
'items' => [
'description' => '数据质量监控运行记录列表。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据质量监控运行记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3155'],
'CreateTime' => ['description' => '数据质量监控运行开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishTime' => ['description' => '数据质量监控运行结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Status' => [
'description' => '当前运行状态。'."\n"
.'- Pass'."\n"
.'- Running'."\n"
.'- Error'."\n"
.'- Warn'."\n"
.'- Fail',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Fail',
],
'Parameters' => [
'description' => '实际运行时，使用的参数设置。'."\n",
'type' => 'array',
'items' => [
'description' => '参数信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '参数名。', 'type' => 'string', 'example' => 'dt'],
'Value' => ['description' => '参数值，可以使用调度时间表达式。', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '数据质量扫描运行记录查询',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityScanRuns',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 324,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityScanRuns\\": [\\n {\\n \\"Id\\": 3155,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Fail\\",\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"dt\\",\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityScans' => [
'summary' => '查询指定项目下的数据质量校验任务列表。',
'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' => '模糊匹配数据质量校验任务名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（默认Asc，可以省略）。排序字段的枚举值如下：'."\n"
."\n"
.'- ModifyTime (Desc/Asc)'."\n"
.'- CreateTime (Desc/Asc)'."\n"
.'- Id (Desc/Asc)',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'ModifyTime Desc',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '列表翻页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '列表翻页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Table',
'in' => 'query',
'schema' => ['description' => '模糊匹配监控的表名。', 'type' => 'string', 'required' => false, 'example' => 'video_album'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'PageInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '列表翻页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DataQualityScans' => [
'description' => '数据质量监控列表。',
'type' => 'array',
'items' => [
'description' => '数据质量监控信息。',
'type' => 'object',
'properties' => [
'ModifyTime' => ['description' => '数据质量监控更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '17236236472'],
'Owner' => ['description' => '数据质量监控责任人用户ID。', 'type' => 'string', 'example' => '23782382795249'],
'Description' => ['description' => '数据质量校验任务描述，最长65535个字符。'."\n", 'type' => 'string', 'example' => 'This is a hourly run data quality evaluation plan.'],
'ModifyUser' => ['description' => '数据质量监控最近更新人用户ID。', 'type' => 'string', 'example' => '23782382795249'],
'Parameters' => [
'description' => '数据质量监控执行参数定义。',
'type' => 'array',
'items' => [
'description' => '数据质量监控执行参数定义。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '参数值。', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]'],
'Name' => ['description' => '参数名。', 'type' => 'string', 'example' => 'dt'],
],
],
],
'CreateTime' => ['description' => '数据质量监控创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1694512304000'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '59094'],
'CreateUser' => ['description' => '数据质量监控创建人。', 'type' => 'string', 'example' => '7892346529452'],
'ComputeResource' => [
'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。',
'type' => 'object',
'properties' => [
'Runtime' => [
'description' => '数据质量监控在运行时的更多设置。',
'type' => 'object',
'properties' => [
'HiveConf' => ['description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', 'type' => 'string', 'example' => 'mapreduce.job.queuename=dq_queue'],
'SparkConf' => ['description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', 'type' => 'string', 'example' => 'spark.yarn.queue=dq_queue'],
'Engine' => [
'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。取值范围：'."\n"
."\n"
.'- Hive：Hive SQL'."\n"
.'- Spark：Spark SQL'."\n"
.'- Kyuubi',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Hive',
],
],
],
'EnvType' => [
'description' => '计算引擎所属的工作空间环境。取值范围：'."\n"
."\n"
.'- Prod：生产环境'."\n"
.'- Dev：开发环境',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Prod',
],
'Name' => ['description' => '计算引擎名字，唯一标识。', 'type' => 'string', 'example' => 'emr_cluster_001'],
],
],
'Name' => ['description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。'."\n", 'type' => 'string', 'example' => 'Hourly partition quality monitoring'],
'RuntimeResource' => [
'description' => '数据质量监控运行时，使用的资源组。',
'type' => 'object',
'properties' => [
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'number', 'format' => 'float', 'example' => '0.25'],
'Id' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'Serverless_resource_group_xxxxx'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxx'],
],
],
'Trigger' => [
'description' => '数据质量监控触发设置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '数据质量监控触发方式。取值范围：'."\n"
."\n"
.'- ByManual：手动触发，默认设置'."\n"
.'- BySchedule：调度任务实例触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'BySchedule',
],
'TaskIds' => [
'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。',
'type' => 'array',
'items' => ['description' => '调度任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1023777390'],
],
],
],
'Hooks' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'array',
'items' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'object',
'properties' => [
'Condition' => ['description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n"
."\n"
.'指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => 'Hook类型。取值范围：'."\n"
."\n"
.'- BlockTaskInstance：阻塞任务实例调度',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'BlockTaskInstance',
],
],
],
],
'Id' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '26433'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '数据质量校验任务列表查询',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityScans',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"DataQualityScans\\": [\\n {\\n \\"ModifyTime\\": 17236236472,\\n \\"Owner\\": \\"23782382795249\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ModifyUser\\": \\"23782382795249\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"CreateTime\\": 1694512304000,\\n \\"ProjectId\\": 59094,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ComputeResource\\": {\\n \\"Runtime\\": {\\n \\"HiveConf\\": \\"mapreduce.job.queuename=dq_queue\\",\\n \\"SparkConf\\": \\"spark.yarn.queue=dq_queue\\",\\n \\"Engine\\": \\"Hive\\"\\n },\\n \\"EnvType\\": \\"Prod\\",\\n \\"Name\\": \\"emr_cluster_001\\"\\n },\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"RuntimeResource\\": {\\n \\"Cu\\": 0.25,\\n \\"Id\\": \\"Serverless_resource_group_xxxxx\\",\\n \\"Image\\": \\"i-xxxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ],\\n \\"Id\\": 26433\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataQualityTemplates' => [
'summary' => '查询指定项目下的数据质量规则模板列表。',
'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' => '数据质量模板所属的目录路径。', 'type' => 'string', 'required' => false, 'example' => '/timeliness/ods_layer'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '模板规则名称模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'table_rows'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '结果分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '结果分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'PageInfo' => [
'description' => '数据质量规则模板分页查询结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageSize' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DataQualityTemplates' => [
'description' => '规则模板列表。',
'type' => 'array',
'items' => [
'description' => '规则模板。',
'type' => 'object',
'properties' => [
'ModifyTime' => ['description' => '数据质量规则模板更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1729816478147'],
'Owner' => ['description' => '数据质量规则模板责任人。', 'type' => 'string', 'example' => '205250754596036836'],
'ModifyUser' => ['description' => '数据质量规则模板最近更新人。', 'type' => 'string', 'example' => '205250754596036836'],
'CreateTime' => ['description' => '数据质量规则模板创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1729816478147'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '7635'],
'CreateUser' => ['description' => '数据质量规则模板创建人。', 'type' => 'string', 'example' => '7892346529452'],
'Id' => ['description' => '数据质量规则模板ID。', 'type' => 'string', 'example' => '819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a'],
'Spec' => ['description' => '数据质量规则模板的具体配置。具体含义，请参见[数据质量Spec配置说明](~~2963394~~)', 'type' => 'string', 'example' => '{'."\n"
.' "assertion": "anomaly detection fro id_not_null_cnt",'."\n"
.' "id_not_null_cnt": {'."\n"
.' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n"
.' },'."\n"
.' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n"
.'}'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '数据质量规则模板列表查询',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"DataQualityTemplates\\": [\\n {\\n \\"ModifyTime\\": 1729816478147,\\n \\"Owner\\": \\"205250754596036836\\",\\n \\"ModifyUser\\": \\"205250754596036836\\",\\n \\"CreateTime\\": 1729816478147,\\n \\"ProjectId\\": 7635,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"Id\\": \\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDataSourceSharedRules' => [
'summary' => '查询某个数据源配置的规则列表。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '235551',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'DataSourceId',
'in' => 'query',
'schema' => ['title' => '数据源Id', 'description' => '数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '135123'],
],
[
'name' => 'TargetProjectId',
'in' => 'query',
'schema' => ['title' => '数据源分享到的目标项目空间ID，不支持分享到本项目', 'description' => '数据源分享到的目标项目空间ID，不支持分享到本项目。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '106565'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'DataSourceSharedRules' => [
'description' => '数据源的分享规则列表。',
'type' => 'array',
'items' => [
'description' => '数据源分享规则的详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据源分享规则的ID，数据源分享规则的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '101412'],
'DataSourceId' => ['description' => '数据源ID，您可以调用[ListDataSources](~~211431~~)获取数据源的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '265133'],
'SharedDataSourceName' => ['description' => '分享后在目标项目空间的数据源名称。', 'type' => 'string', 'example' => 'targetProject.datasource'],
'SourceProjectId' => ['description' => '数据源的源项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '106560'],
'TargetProjectId' => ['description' => '数据源的目标项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '106561'],
'SharedUser' => ['description' => '数据源分享到目标项目空间下的用户。若分享到整个项目，则该字段为空。', 'type' => 'string', 'example' => '1107550004253538'],
'EnvType' => ['description' => '目标数据源所属的环境。取值如下：'."\n"
.'- Dev：开发环境。'."\n"
.'- Prod：生产环境。', 'type' => 'string', 'example' => 'Dev'],
'CreateTime' => ['description' => '数据源分享规则的创建时间（时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1724379762000'],
'CreateUser' => ['description' => '数据源分享规则的创建者ID。', 'type' => 'string', 'example' => '1107550****'],
],
],
],
],
],
],
],
'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' => '查询数据源分享规则列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 操作人想要查看一个数据源的分享规则，该数据源位于A空间，则操作人需要在A空间具有数据源分享的权限点。需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、租户管理员、空间管理员、项目所有者',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListDataSourceSharedRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListDataSources' => [
'summary' => '根据数据源业务信息，查询符合的数据源列表。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '232439',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '17820'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '数据源名称，基于此名称做模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Types',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => '数据源类型查询过滤，可以配置多个类型查询过滤。',
'type' => 'array',
'items' => ['description' => '数据源的类型。', 'type' => 'string', 'required' => false, 'example' => 'mysql'],
'required' => false,
],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => ['description' => '数据源环境类型，枚举值：'."\n"
.'- Dev：开发环境'."\n"
.'- Prod：生产环境', 'type' => 'string', 'required' => false, 'example' => 'Prod'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '查询第几页，默认值为1表示第一页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，默认值为10，最大值100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '数据源列表排序字段，支持名称、创建时间、数据源ID排序'."\n"
.'- CreateTime：创建时间'."\n"
.'- Id：数据源ID'."\n"
.'- Name：数据源名称'."\n"
."\n"
.'默认值：CreateTime', 'type' => 'string', 'required' => false, 'example' => 'CreateTime'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '数据源列表排序方向，枚举值：'."\n"
.'- Desc：倒序'."\n"
.'- Asc：正序'."\n"
."\n"
.'默认值：Desc', 'type' => 'string', 'required' => false, 'example' => 'Desc'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => '数据源可以打标签，基于标签做数据源查询过滤：'."\n"
.'- 多个值之间是“且”的关系，比如`["tag1", "tag2", "tag3"]`底层查询同时有这3个标签打标的数据源列表。'."\n"
.'- 不传递，或者传递为空表示不作tag过滤，查询最多支持10个标签。', 'type' => 'string', 'required' => false, 'example' => '["tag1", "tag2", "tag3"] '],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '7BE1433F-6D55-5D86-9344-CA6F7DD19B13'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '131'],
'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'DataSources' => [
'description' => '数据源列表，每一个元素是一个数据源组，包含开发环境（如有）和生产环境的信息。',
'type' => 'array',
'items' => [
'description' => '数据源组信息，包含开发环境（如有）和生产环境的数据源。开发环境和生产环境的数据源具有相同的数据源名称和数据源类型，不相同的数据源ID。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源的名称。', 'type' => 'string', 'example' => 'test'],
'Type' => ['description' => '数据源类型。', 'type' => 'string', 'example' => 'mysql'],
'DataSource' => [
'description' => '数据源列表，每个元素是单个数据源信息，具有唯一的数据源ID。',
'type' => 'array',
'items' => [
'description' => '单条数据源信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '16035'],
'ConnectionProperties' => ['description' => '数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境envType信息是此对象的成员属性，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）'."\n"
."\n"
.'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', 'type' => 'any', 'example' => '{'."\n"
.' "envType": "Prod",'."\n"
.' "regionId": "cn-beijing",'."\n"
.' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n"
.' "database": "testdb",'."\n"
.' "securityProtocol": "authTypeNone",'."\n"
.' "authType": "Executor",'."\n"
.' "authIdentity": "1107550004253538"'."\n"
.'}'],
'ConnectionPropertiesMode' => ['description' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n"
.'- InstanceMode 实例模式。'."\n"
.'- UrlMode 连接串模式。', 'type' => 'string', 'example' => 'UrlMode'],
'Description' => ['description' => '数据源的描述信息。', 'type' => 'string', 'example' => 'test '],
'CreateTime' => ['description' => '数据源的创建时间（时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1648711113000'],
'CreateUser' => ['description' => '数据源的创建者ID。', 'type' => 'string', 'example' => '1624387842781448'],
'ModifyTime' => ['description' => '数据源的最近修改时间（时间戳）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1648711113000'],
'ModifyUser' => ['description' => '数据源的修改者ID。', 'type' => 'string', 'example' => '1624387842781448'],
'QualifiedName' => ['description' => '数据源的业务唯一键，以holo举例格式是`${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`。', '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' => '获取数据源列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListDataSources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListDatabases' => [
'summary' => '查询数据地图中给定实例/集群/数据目录下的数据库列表。'."\n"
.'对于dlf/starrocks类型，查询给定数据目录下的数据库列表，其中starocks类型仅支持查询Internal Catalog；'."\n"
.'对于其他类型，查询给定实例/集群下的数据库列表。',
'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' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'父层级实体类型参考ListCrawlerTypes接口'."\n"
."\n"
.'- 若父层级实体为数据目录，`ParentMetaEntityId`格式参考ListCatalogs接口返回结果。'."\n"
."\n"
.'- 如果父层级实体为元数据采集器，`ParentMetaEntityId`格式为`${CrawlerType}:${实例ID或转义后的URL}`。'."\n"
."\n"
.'几种常用类型的ParentMetaEntityId格式参考如下：'."\n"
."\n"
.'- `dlf-catalog::catalog_id`'."\n"
."\n"
.'- `holo:instance_id`'."\n"
."\n"
.'- `mysql:(instance_id|encoded_jdbc_url)`'."\n"
."\n"
.'> 其中 '."\n"
.'- `catalog_id`: dlf目录id。'."\n"
.'- `instance_id`: 实例ID，对应数据源以实例模式注册时需要提供。'."\n"
.'- `encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供。', 'type' => 'string', 'required' => true, 'example' => 'holo:instance_id'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '名称，模糊匹配', 'description' => '名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test_tbl'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['title' => '注释，模糊匹配', 'description' => '注释，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test comment'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为CreateTime',
'description' => '排序字段，默认为CreateTime，枚举值，当前支持：'."\n"
."\n"
.'- CreateTime：创建时间'."\n"
.'- ModifyTime：修改时间'."\n"
.'- Name：名称',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CreateTime',
'pattern' => '^[\\w.,;/@-]+$',
'default' => 'CreateTime',
'enum' => ['CreateTime', 'ModifyTime', 'Name'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持：'."\n"
."\n"
.'- Asc：升序'."\n"
.'- Desc：降序',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100。', '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' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9DD08926-38B9-XXXXXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页结果',
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Databases' => [
'description' => '数据库列表。',
'type' => 'array',
'items' => ['description' => '数据库信息。', '$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' => '查询数据地图数据库列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 对于starrocks类型，当前仅支持查询Internal catalog',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDatabases',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListDatasetVersions' => [
'summary' => '查询给定数据集的版本列表。',
'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' => '数据集ID', 'type' => 'string', 'required' => true, 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'],
],
[
'name' => 'CreatorId',
'in' => 'formData',
'schema' => ['title' => '创建者ID', 'description' => '创建者ID', 'type' => 'string', 'required' => false, 'example' => '12103XXX46492139'],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => [
'title' => '排序字段',
'description' => '排序字段，默认为VersionNumber（版本号）',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ModifyTime' => '修改时间', 'CreateTime' => '创建时间', 'VersionNumber' => '版本号'],
'example' => 'CreateTime',
'default' => 'VersionNumber',
'enum' => ['CreateTime', 'ModifyTime', 'VersionNumber'],
],
],
[
'name' => 'Order',
'in' => 'formData',
'schema' => [
'title' => '排序方向',
'description' => '排序方向，默认为Desc（降序）',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Asc' => '升序', 'Desc' => '降序'],
'example' => 'Desc',
'default' => 'Desc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['title' => '分页大小，默认为10，最大100', 'description' => '分页大小，默认为10，最大100', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367XXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页信息',
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DatasetVersions' => [
'title' => '数据集版本列表',
'description' => '数据集版本列表',
'type' => 'array',
'items' => ['title' => '数据集版本', 'description' => '数据集版本', '$ref' => '#/components/schemas/DatasetVersion'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据集版本列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367XXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DatasetVersions\\": [\\n {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDatasets' => [
'summary' => '查询数据集列表，当前支持DataWorks数据集与PAI数据集。',
'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' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '251363'],
],
[
'name' => 'Origin',
'in' => 'formData',
'schema' => ['title' => '数据集来源，取值有'."\n"
.'- DataWorks'."\n"
.'- PAI', 'description' => '数据集来源，取值有'."\n"
.'- DataWorks'."\n"
.'- PAI', 'type' => 'string', 'required' => false, 'example' => 'DataWorks'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '数据集名称，支持模糊搜索', 'description' => '数据集名称，支持模糊搜索', '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' => '数据类型，可多选，当前支持'."\n"
.'- COMMON 通用'."\n"
.'- PIC 图片'."\n"
.'- TEXT 文本'."\n"
.'- TABLE 表格'."\n"
.'- VIDEO 视频'."\n"
.'- AUDIO 音频'."\n"
.'- INDEX 索引',
'type' => 'array',
'items' => [
'description' => '数据类型',
'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' => '存储类型，可多选，当前支持'."\n"
.'- OSS 对象存储'."\n"
.'- NAS 通用型NAS文件存储'."\n"
.'- EXTREMENAS 极速型NAS文件存储'."\n"
.'- DLF_LANCE 数据湖构建'."\n"
.'- CPFS CPFS文件存储'."\n"
.'- BMCPFS 智算CPFS文件存储'."\n"
.'- MAXCOMPUTE MaxCompute表',
'type' => 'array',
'items' => ['description' => '存储类型', 'type' => 'string', 'required' => false, 'example' => 'NAS'],
'required' => false,
'enumValueTitles' => ['NAS' => '通用型NAS文件存储', 'MAXCOMPUTE' => 'MaxCompute表', 'CPFS' => 'CPFS文件存储', 'BMCPFS' => '智算CPFS文件存储', 'EXTREMENAS' => '极速型NAS文件存储', 'OSS' => '对象存储', 'DLF_LANCE' => '数据湖构建'],
'maxItems' => 10,
'minItems' => 0,
],
],
[
'name' => 'CreatorId',
'in' => 'formData',
'schema' => ['title' => '创建者ID', 'description' => '创建者ID', 'type' => 'string', 'required' => false, 'example' => '12103XXX46492139'],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => [
'title' => '排序字段',
'description' => '排序字段，默认为 CreateTime(创建时间)',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ModifyTime' => '修改时间', 'CreateTime' => '创建时间', 'Name' => '名称'],
'example' => 'CreateTime',
'default' => 'CreateTime',
'enum' => ['Name', 'CreateTime', 'ModifyTime'],
],
],
[
'name' => 'Order',
'in' => 'formData',
'schema' => [
'title' => '排序方向',
'description' => '排序方向，默认为Desc（降序）',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Asc' => '升序', 'Desc' => '降序'],
'example' => 'Asc',
'default' => 'Desc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['title' => '分页大小，默认为10，最大100', 'description' => '分页大小，默认为10，最大100', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n"],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页信息',
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Datasets' => [
'title' => '数据集列表',
'description' => '数据集列表',
'type' => 'array',
'items' => ['title' => '数据集对象', 'description' => '数据集对象', '$ref' => '#/components/schemas/Dataset'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询数据集列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDatasets',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Datasets\\": [\\n {\\n \\"Id\\": \\"dataworks-dataset:1gxxxqjx155usz3hrv\\",\\n \\"Name\\": \\"test_dataset\\",\\n \\"Comment\\": \\"测试数据集\\",\\n \\"ProjectId\\": 123456,\\n \\"Origin\\": \\"DataWorks\\",\\n \\"DataType\\": \\"COMMON\\",\\n \\"StorageType\\": \\"OSS\\",\\n \\"CreatorId\\": \\"210484359\\",\\n \\"Readme\\": \\"## introduction\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n },\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListDeploymentPackageFiles' => [
'summary' => '获取待发布的文件版本列表。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'BusinessId',
'in' => 'query',
'schema' => ['description' => '业务流程的ID，您可以调用[ListBusiness](~~173945~~)接口，根据名称查询对应业务流程的ID。'."\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001'],
],
[
'name' => 'SolutionId',
'in' => 'query',
'schema' => ['description' => '解决方案ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8065'],
],
[
'name' => 'CommitFrom',
'in' => 'query',
'schema' => ['description' => '提交起始日期，格式yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2025-01-01'],
],
[
'name' => 'CommitTo',
'in' => 'query',
'schema' => ['description' => '提交截止日期（包含），格式yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2025-01-31'],
],
[
'name' => 'CommitUserId',
'in' => 'query',
'schema' => ['description' => '提交人的用户ID', 'type' => 'string', 'required' => false, 'example' => '2003****'."\n"],
],
[
'name' => 'FileType',
'in' => 'query',
'schema' => ['description' => '文件的代码类型。'."\n"
."\n"
.'不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。'."\n"
.'您也可以调用[ListFileType](~~212428~~)接口，查询文件的代码类型。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'ChangeType',
'in' => 'query',
'schema' => ['description' => '变更类型 '."\n"
.'- 0：新增'."\n"
.'- 1：更新'."\n"
.'- 2：删除', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'FileIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '需要查询的文件ID列表。',
'type' => 'array',
'items' => ['description' => '需要查询的文件ID。', 'type' => 'string', 'required' => false, 'example' => '11223**'],
'required' => false,
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => '文件的名称。', 'type' => 'string', 'required' => false, 'example' => 'Filename'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页的页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10，最大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',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageNumber' => ['description' => '分页页码，从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小，默认为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DeploymentPackageFiles' => [
'description' => '具体的待发布的文件版本信息列表',
'type' => 'array',
'items' => [
'description' => '具体的待发布的文件版本信息',
'type' => 'object',
'properties' => [
'Id' => ['description' => '唯一标识', 'type' => 'integer', 'format' => 'int64', 'example' => '650433503'],
'FileId' => ['description' => '文件的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '520246913'],
'FileVersion' => ['description' => '文件的版本号', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
'CommitTime' => ['description' => '提交时间', 'type' => 'string', 'example' => '2025-04-10 15:55:47'],
'CommitUser' => ['description' => '提交人的阿里云账号ID', 'type' => 'string', 'example' => '446***'],
'CommitUserName' => ['description' => '提交人的阿里云账号名称', 'type' => 'string', 'example' => 'user***'],
'ProjectId' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '27595'],
'TenantId' => ['description' => 'DataWorks租户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '639415964191360'],
'FileType' => ['description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
'FileName' => ['description' => '生成本次文件版本的文件名。'."\n", 'type' => 'string', 'example' => 'bak_part_basc_person_relation_all_da'],
'Status' => ['description' => '该版本的代码文件的状态 '."\n"
.'- 2：提交检查中'."\n"
.'- 3：提交检查成功'."\n"
.'- 4：提交检查拒绝'."\n"
.'- 10：提交中 '."\n"
.'- 11：已经提交至调度的开发 '."\n"
.'- 20：审核通过'."\n"
.'- 21：审核失败'."\n"
.'- 22：检查存在告警'."\n"
.'- 23：代码审核中'."\n"
.'- 24：代码审核拒绝'."\n"
.'- 80：创建发布包成功 '."\n"
.'- 100：发布中 '."\n"
.'- 101：发布至生产 '."\n"
.'- 200：取消', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'ChangeType' => ['description' => 'Integer 变更类型 '."\n"
.'- 0：新增'."\n"
.'- 1：更新'."\n"
.'- 2：删除', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'IsSameAsProductionVersion' => ['description' => '该版本是否是当前调度生产上的版本', 'type' => 'boolean', 'example' => 'true'],
'NodeId' => ['description' => '该文件对应的调度上的节点id', 'type' => 'integer', 'format' => 'int64', 'example' => '700005008419'],
'Comment' => ['description' => '提交时的注释', 'type' => 'string', 'example' => 'Test submission'],
'NodeConfiguration' => ['description' => '保存该文件所在调度节点的调度属性配置信息（Json串的形式保存）', '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' => '文件所属的功能模块。取值如下：'."\n"
.'- NORMAL：数据开发。'."\n"
.'- MANUAL：手动任务。'."\n"
.'- MANUAL_BIZ：手动业务流程。'."\n"
.'- SKIP：数据开发的空跑调度。'."\n"
.'- ADHOCQUERY：临时查询。'."\n"
.'- COMPONENT：组件管理。', 'type' => 'string', 'example' => 'NORMAL'],
'SmokeTestStatus' => ['description' => '开发环境测试情况', 'type' => 'string', 'example' => 'Not tested'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DeploymentPackageFiles\\": [\\n {\\n \\"Id\\": 650433503,\\n \\"FileId\\": 520246913,\\n \\"FileVersion\\": 34,\\n \\"CommitTime\\": \\"2025-04-10 15:55:47\\",\\n \\"CommitUser\\": \\"446***\\",\\n \\"CommitUserName\\": \\"user***\\",\\n \\"ProjectId\\": 27595,\\n \\"TenantId\\": 639415964191360,\\n \\"FileType\\": 13,\\n \\"FileName\\": \\"bak_part_basc_person_relation_all_da\\",\\n \\"Status\\": 100,\\n \\"ChangeType\\": 0,\\n \\"IsSameAsProductionVersion\\": true,\\n \\"NodeId\\": 700005008419,\\n \\"Comment\\": \\"Test submission\\",\\n \\"NodeConfiguration\\": \\"{\\\\n\\\\t\\\\\\"tagList\\\\\\": [],\\\\n\\\\t\\\\\\"fileId\\\\\\": -1,\\\\n\\\\t\\\\\\"taskRerunTime\\\\\\": 0,\\\\n\\\\t\\\\\\"taskRerunInterval\\\\\\": 0,\\\\n\\\\t\\\\\\"reRunAble\\\\\\": 1,\\\\n\\\\t\\\\\\"nodeId\\\\\\": 125803000,\\\\n\\\\t\\\\\\"nodeName\\\\\\": \\\\\\"new\\\\\\",\\\\n\\\\t\\\\\\"nodeType\\\\\\": 0,\\\\n\\\\t\\\\\\"isStop\\\\\\": 0,\\\\n\\\\t\\\\\\"paraValue\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"startEffectDate\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"endEffectDate\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"cronExpress\\\\\\": \\\\\\"00 26 00 * * ?\\\\\\",\\\\n\\\\t\\\\\\"owner\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"resgroupId\\\\\\": 6300000,\\\\n\\\\t\\\\\\"cu\\\\\\": \\\\\\"0.25\\\\\\",\\\\n\\\\t\\\\\\"appId\\\\\\": 170000,\\\\n\\\\t\\\\\\"tenantId\\\\\\": 524257424560000,\\\\n\\\\t\\\\\\"createTime\\\\\\": \\\\\\"2025-04-10 15:55:01\\\\\\",\\\\n\\\\t\\\\\\"createUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"lastModifyTime\\\\\\": \\\\\\"2025-04-10 15:55:41\\\\\\",\\\\n\\\\t\\\\\\"cycleType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentTypeList\\\\\\": [0],\\\\n\\\\t\\\\\\"lastModifyUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"dependentDataNode\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"input\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"regionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-hangzhou\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"root_input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"output\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.526586287_out\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":2},{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.new\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"inputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"root_input\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"outputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.526586287_out\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 2\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.new\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"isAutoParse\\\\\\": 1,\\\\n\\\\t\\\\\\"startRightNow\\\\\\": false,\\\\n\\\\t\\\\\\"extConfig\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"openCustomCron\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formCron\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\\\\\",\\\\n\\\\t\\\\\\"inputContextList\\\\\\": [],\\\\n\\\\t\\\\\\"outputContextList\\\\\\": []\\\\n}\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"SmokeTestStatus\\": \\"Not tested\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取待发布的文件版本列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListDeploymentPackages' => [
'summary' => '查询发布包列表。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '269317',
'abilityTreeNodes' => ['FEATUREdide8FM783'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，'."\n"
.'即数据开发页面顶部切换工作空间处的英文标识。该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10003'],
],
[
'name' => 'Creator',
'in' => 'formData',
'schema' => ['description' => '发布包创建者的阿里云账号UID。', 'type' => 'string', 'required' => false, 'example' => '110755000425****'],
],
[
'name' => 'EndCreateTime',
'in' => 'formData',
'schema' => ['description' => '生成发布包的'."\n"
.'最大毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593877765000'],
],
[
'name' => 'Executor',
'in' => 'formData',
'schema' => ['description' => '发布包执行者的阿里云账号UID。', 'type' => 'string', 'required' => false, 'example' => '2003****'],
],
[
'name' => 'EndExecuteTime',
'in' => 'formData',
'schema' => ['description' => '发布包开始执行的'."\n"
.'最大毫秒时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593877765000'],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => ['description' => '发布包当前的状态。取值如下：'."\n"
.'- 0：发布包已准备就绪。'."\n"
.'- 1：发布包发布成功。'."\n"
.'- 2：发布包发布失败。'."\n"
.'- 6：发布包被驳回。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Keyword',
'in' => 'formData',
'schema' => ['description' => '发布包名称的关键字。'."\n"
.'DataWorks支持模糊匹配，即输入关键字，即可查询包含该关键字的发布包。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '分页的'."\n"
.'页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为10条，'."\n"
.'最大100条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一ID。', 'type' => 'string', 'example' => '952795279527ab****'],
'Data' => [
'description' => '满足查询条件的发布包列表。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码'."\n"
.'数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页的'."\n"
.'大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'TotalCount' => ['description' => '满足条件的'."\n"
.'数据总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'Deployments' => [
'description' => '返回的'."\n"
.'发布包列表。',
'type' => 'array',
'items' => [
'description' => '发布包的'."\n"
.'详细信息。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '发布包当前的状态。取值如下：'."\n"
."\n"
.'- 0：发布包已准备就绪。'."\n"
.'- 1：发布包发布成功。'."\n"
.'- 2：发布包发布失败。'."\n"
.'- 6：发布包被驳回。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ErrorMessage' => ['description' => '当发布包执行失败，'."\n"
.'该参数用于记录错误信息。', 'type' => 'string', 'example' => 'OK'],
'CreateTime' => ['description' => '发布包创建的'."\n"
.'时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000'],
'Executor' => ['description' => '发布包执行者的'."\n"
.'阿里云用户ID。', 'type' => 'string', 'example' => '2003****'],
'Creator' => ['description' => '发布包创建者的'."\n"
.'阿里云用户ID。', 'type' => 'string', 'example' => '2003****'],
'ExecuteTime' => ['description' => '执行发布包的'."\n"
.'时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000'],
'Name' => ['description' => '发布包的'."\n"
.'名称。', 'type' => 'string', 'example' => 'auto_created'],
'Id' => ['description' => '发布包的ID，'."\n"
.'您可以根据此ID调用[GetDeployment](~~173950~~)接口，获取发布包详情。', 'type' => 'integer', 'format' => 'int64', 'example' => '11111'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"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' => '查询发布包列表信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TaskInstances' => [
'description' => '任务实例列表。该字段已废弃，请使用DownstreamTaskInstances。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StepType' => ['title' => '依赖类型', 'description' => '依赖类型。'."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'TaskId' => ['description' => '对应任务的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'TaskType' => ['title' => '任务类型', 'description' => '对应任务的类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'TaskName' => ['description' => '对应任务的名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowName' => ['description' => '所属工作流的名称。', 'type' => 'string', 'example' => 'Test workflow'],
'TriggerType' => [
'description' => '触发方式类型。',
'type' => 'string',
'enumValueTitles' => ['Scheduler' => '调度周期触发', 'Manual' => '手动触发'],
'example' => 'Scheduler',
],
'TriggerRecurrence' => [
'description' => '触发时的运行模式。TriggerType=Scheduler时生效。',
'type' => 'string',
'enumValueTitles' => ['Pause' => '暂停', 'Skip' => '空跑', 'Normal' => '正常运行'],
'example' => 'Normal',
],
'WorkflowInstanceId' => ['description' => '所属工作流实例的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowInstanceType' => [
'description' => '所属工作流实例的类型。',
'type' => 'string',
'enumValueTitles' => ['SmokeTest' => '测试', 'SupplementData' => '补数据', 'Manual' => '手动', 'ManualWorkflow' => '手动工作流', 'Normal' => '周期调度', 'ManualFlow' => '手动执行的业务流程'],
'example' => 'Normal',
],
'Timeout' => ['description' => '任务执行超时时间，单位为秒。'."\n"
."\n"
.'注意：调度系统会对任务的设定值按小时取整。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。',
'type' => 'string',
'enumValueTitles' => ['AllDenied' => '失败或成功都不可重跑', 'FailureAllowed' => '只有失败可重跑', 'AllAllowed' => '失败或成功均可重跑'],
'example' => 'AllAllowed',
],
'RunNumber' => ['description' => '当前运行的次数，默认从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PeriodNumber' => ['description' => '周期序号。表示任务实例处于当天的第几轮周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'BaselineId' => ['description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RuntimeResource' => [
'description' => '实例关联资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'Runtime' => [
'description' => '实例运行时信息。',
'type' => 'object',
'properties' => [
'ProcessId' => ['description' => '运行唯一ID。', 'type' => 'string', 'example' => 'T3_123'."\n"],
'Gateway' => ['description' => '运行机器。', 'type' => 'string', 'example' => 'cn-shanghai.1.2'],
],
],
'DataSource' => [
'description' => '实例关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'."\n"],
],
],
'Status' => [
'title' => '实例运行状态',
'description' => '实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件检验'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检'."\n"
.'- WaitTrigger：等待外部触发，触发式节点会在等待时间后变成等待触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Success',
],
'TriggerTime' => ['description' => '定时触发时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'Bizdate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'Id' => ['description' => '任务实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。该字段已废弃，请使用EnvType。',
'type' => 'string',
'deprecated' => true,
'enumValueTitles' => [],
'example' => 'Prod',
],
'EnvType' => ['description' => '目标数据源所属的环境。取值如下：'."\n"
.'- Dev：开发环境。'."\n"
.'- Prod：生产环境。', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '100'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'."\n"],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'."\n"],
],
],
],
'DownstreamTaskInstances' => [
'description' => '下游任务实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DependencyType' => ['title' => '依赖类型', 'description' => '依赖类型。'."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'TaskInstance' => [
'title' => '任务实例',
'description' => '任务实例',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '对应任务的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'TaskType' => ['title' => '任务类型', 'description' => '对应任务的类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'TaskName' => ['description' => '对应任务的名称。', 'type' => 'string', 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowName' => ['description' => '所属工作流的名称。', 'type' => 'string', 'example' => 'Test workflow'],
'TriggerType' => ['description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发', 'type' => 'string', 'example' => 'Scheduler'],
'TriggerRecurrence' => ['description' => '触发时的运行模式，TriggerType=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行', 'type' => 'string', 'example' => 'Normal'],
'WorkflowInstanceId' => ['description' => '所属工作流实例的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowInstanceType' => ['description' => '所属工作流实例的类型。'."\n"
.'- Normal：周期调度'."\n"
.'- Manual：手动任务'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- ManualWorkflow：手动工作流', 'type' => 'string', 'example' => 'Normal'],
'Timeout' => ['description' => '任务执行超时时间，单位为秒。'."\n"
."\n"
.'注意：调度系统会对任务的设定值按小时取整。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => ['title' => '任务是否允许重跑的配置', 'description' => '任务是否允许重跑的配置。', 'type' => 'string', 'example' => 'AllAllowed'],
'RunNumber' => ['description' => '当前运行的次数，默认从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PeriodNumber' => ['description' => '周期序号。表示任务实例处于当天的第几轮周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'BaselineId' => ['description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RuntimeResource' => [
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'Runtime' => [
'description' => '实例运行时信息。',
'type' => 'object',
'properties' => [
'ProcessId' => ['description' => '运行唯一ID。', 'type' => 'string', 'example' => 'T3_123'],
'Gateway' => ['description' => '运行机器。', 'type' => 'string', 'example' => 'cn-shanghai.1.2'],
],
],
'DataSource' => [
'description' => '实例关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'Status' => ['title' => '实例运行状态', 'description' => '实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件检验'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检'."\n"
.'- WaitTrigger：等待外部触发，触发式节点会在等待时间后变成等待触发', 'type' => 'string', 'example' => 'Success'],
'TriggerTime' => ['description' => '定时触发时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Bizdate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Id' => ['description' => '任务实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '目标数据源所属的环境。取值如下：'."\n"
.'- Dev：开发环境。'."\n"
.'- Prod：生产环境。', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'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' => '获取下游任务实例列表',
'summary' => '分页获取指定任务实例的下游任务实例列表。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'ProjectEnv',
'in' => 'query',
'schema' => [
'description' => '项目环境。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Prod' => '生产', 'Dev' => '开发'],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'Tasks' => [
'description' => '任务列表。该字段已废弃，请使用DownstreamTasks。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'InstanceMode' => ['description' => '实例生成模式。'."\n"
."\n"
.'- T+1（第二天生成）'."\n"
.'- Immediately（立即生成）', 'type' => 'string', 'example' => 'T+1'],
'Type' => ['title' => '任务类型', 'description' => '任务类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位秒', 'description' => '任务执行超时时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。',
'type' => 'string',
'enumValueTitles' => ['AllDenied' => '失败或成功都不可重跑', 'FailureAllowed' => '只有失败可重跑', 'AllAllowed' => '失败或成功均可重跑'],
'example' => 'AllAllowed',
],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Trigger' => [
'title' => '任务触发方式',
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。',
'type' => 'string',
'enumValueTitles' => ['Scheduler' => '调度周期触发', 'Manual' => '手动触发'],
'example' => 'Scheduler',
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。',
'type' => 'string',
'enumValueTitles' => ['Pause' => '暂停', 'Skip' => '空跑', 'Normal' => '正常运行'],
'example' => 'Normal'."\n",
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'],
'Timezone' => ['description' => '时区。', 'type' => 'string', 'example' => 'Asia/Shanghai'],
],
],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n"],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'."\n"],
],
],
'Id' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。该字段已废弃，请使用EnvType。',
'type' => 'string',
'deprecated' => true,
'enumValueTitles' => ['Prod' => '生产', 'Dev' => '开发'],
'example' => 'Prod',
],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'StepType' => ['description' => '依赖类型。'."\n"
."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
'DownstreamTasks' => [
'description' => '下游任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DependencyType' => ['title' => '依赖类型', 'description' => '依赖类型。'."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'Task' => [
'description' => '任务的详细信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'InstanceMode' => ['description' => '实例生成模式。'."\n"
.'- T+1：第二天生成'."\n"
.'- Immediately：立即生成', 'type' => 'string', 'example' => 'T+1'],
'Type' => ['title' => '任务类型', 'description' => '任务类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最大值8，最小值1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位秒', 'description' => '任务执行超时时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => ['title' => '任务是否允许重跑的配置', 'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑', 'type' => 'string', 'example' => 'AllAllowed'],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Trigger' => [
'title' => '任务触发方式',
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发', 'type' => 'string', 'example' => 'Scheduler'],
'Recurrence' => ['description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行', 'type' => 'string', 'example' => 'Normal'],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'],
'Timezone' => ['description' => '时区。', 'type' => 'string', 'example' => 'Asia/Shanghai'],
],
],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'Id' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'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' => '获取下游任务列表',
'summary' => '分页获取指定任务的下游任务列表。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-13T08:44:56.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListEntitiesInMetaCollection' => [
'summary' => '查询数据地图集合中的实体列表，集合支持数据地图类目和数据专辑，实体当前仅支持数据表类型。',
'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' => '集合对象Id。', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd'],
],
[
'name' => 'EntityType',
'in' => 'query',
'schema' => ['description' => '实体类型。', 'type' => 'string', 'required' => false, 'example' => 'dlf-table'],
],
[
'name' => 'EntityName',
'in' => 'query',
'schema' => ['description' => '实体名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test1'],
],
[
'name' => 'EntityDescription',
'in' => 'query',
'schema' => ['description' => '添加实体到集合时的描述，模糊匹配，目前仅专辑类型支持。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序字段, 支持'."\n"
."\n"
.' - Name 名称（默认）'."\n"
.' - CreateTime 实体创建时间', 'type' => 'string', 'required' => false, 'example' => 'Name'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排序方向，支持'."\n"
."\n"
.' - Asc（默认）'."\n"
.' - Desc', 'type' => 'string', 'required' => false, 'example' => 'Asc'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，默认为10，最大为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28'],
'PagingInfo' => [
'description' => '分页结果对象。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Entities' => [
'description' => '集合实体列表。',
'type' => 'array',
'items' => [
'description' => '集合实体。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '实体对象的Id，目前仅支持Table资源类型'."\n"
.'如果实体已删除，此处返回空。', 'type' => 'string', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
'Type' => ['description' => '实体类型。', 'type' => 'string', 'example' => 'maxcompute-table'],
'Name' => ['description' => '实体名称。', 'type' => 'string', 'example' => 'test_table'],
'Comment' => ['description' => '实体注释。', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['description' => '创建时间毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1737078994080'],
'ModifyTime' => ['description' => '修改时间毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1737078994080'],
'Description' => ['description' => '添加到集合时的描述信息，目前仅对专辑有效。', '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' => '查询数据地图集合中的实体列表',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '文件的ID，'."\n"
.'您可以通过[ListFiles](~~173942~~)查询对应文件的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100000001'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID，'."\n"
.'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，即数据开发页面顶部切换工作空间处的英文标识。'."\n"
."\n\n"
.'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '请求的数据页数，'."\n"
.'用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为10条，'."\n"
.'最大100条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '文件的版本列表'."\n"
.'。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '当前数据页的页码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '当前数据页的大小'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '满足查询条件的数据总条数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
'FileVersions' => [
'description' => '文件的版本详情列表'."\n"
.'。',
'type' => 'array',
'items' => [
'description' => '文件的版本详情'."\n"
.'。',
'type' => 'object',
'properties' => [
'FileContent' => ['description' => '生成本次文件版本的文件代码'."\n"
.'。', 'type' => 'string', 'example' => 'SHOW TABLES;'],
'Status' => ['description' => '文件版本当前的状态，'."\n"
.'包括COMMITTING（提交中）、COMMITTED或CHECK_OK（已提交）、PACKAGED（准备发布）、DEPLOYING（发布中）、DEPLOYED（已发布）和CANCELLED（取消发布）。', 'type' => 'string', 'example' => 'COMMITTED'],
'IsCurrentProd' => ['description' => '本次文件版本是否为当前生产环境的最新版本。'."\n"
."\n"
.'- true：是最新版本。'."\n"
.'- false：不是最新版本。', 'type' => 'boolean', 'example' => 'false'],
'CommitUser' => ['description' => '生成本次文件版本的阿里云用户ID'."\n"
.'。', 'type' => 'string', 'example' => '73842342****'."\n"],
'NodeContent' => ['description' => '生成本次文件版本的调度配置'."\n"
.'。', 'type' => 'string', 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}'],
'Comment' => ['description' => '本次文件版本的说明'."\n"
.'。', 'type' => 'string', 'example' => 'Second version submission'],
'FilePropertyContent' => ['description' => '生成本次文件版本的文本基本信息'."\n"
.'。', 'type' => 'string', 'example' => '{"fileName":"ods_user_info_d","fileType":10}'],
'FileName' => ['description' => '生成本次文件版本的文件名'."\n"
.'。', 'type' => 'string', 'example' => 'ods_user_info_d'],
'UseType' => ['description' => '文件所属的功能模块，'."\n"
.'包括NORMAL（数据开发）、MANUAL（手动任务）、MANUAL_BIZ（手动工作流）、SKIP（数据开发的空跑调度）、ADHOCQUERY（临时查询）和COMPONENT（组件管理）。', 'type' => 'string', 'example' => 'NORMAL'],
'ChangeType' => ['description' => '本次文件版本的变更类型，包括CREATE、UPDATE和DELETE'."\n"
.'。', 'type' => 'string', 'example' => 'UPDATE'],
'FileVersion' => ['description' => '文件的版本'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'CommitTime' => ['description' => '生成文件版本的毫秒时间戳'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593881265000'],
'NodeId' => ['description' => '生成文件版本时对应的调度任务ID'."\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.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"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' => '查询文件的版本列表',
'summary' => '调用ListFileVersions查询文件的版本列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '文件所在的文件夹路径'."\n"
.'。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n\n"
.'该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'Keyword',
'in' => 'formData',
'schema' => ['description' => '文件名称的关键字。支持模糊匹配，'."\n"
.'即输入关键字即可查询包含该关键字的所有文件。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ods'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n"
."\n\n"
.'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '请求的数据页数，'."\n"
.'用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为10条，'."\n"
.'最大为100条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'default' => '10'],
],
[
'name' => 'UseType',
'in' => 'formData',
'schema' => ['description' => '文件所属的功能模块。取值如下：'."\n"
."\n"
.'- NORMAL：数据开发。'."\n"
.'- MANUAL：手动任务。'."\n"
.'- MANUAL_BIZ：手动业务流程。'."\n"
.'- SKIP：数据开发的空跑调度。'."\n"
.'- ADHOCQUERY：临时查询。'."\n"
.'- COMPONENT：组件管理。', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'],
],
[
'name' => 'FileTypes',
'in' => 'formData',
'schema' => ['description' => '文件的代码类型。'."\n"
."\n\n"
.'常用的代码及其对应的文件类型包括6（Shell）、10（ODPS SQL）、11（ODPS MR）、23（数据集成）、24（ODPS Script）、97（PAI）、98（组合节点）、99（虚拟节点）、221（PyODPS 2）、225（ODPS Spark）、227（EMR Hive）、228（EMR Spark）、229（EMR Spark SQL）、230（EMR MR）、239（OSS对象检查）、257（EMR Shell）、258（EMR Spark Shell）、259（EMR Presto）、260（EMR Impala）、900（实时同步）、1002（PAI内部节点）、1089（跨租户节点）、1091（Hologres开发）、1093（Hologres SQL）、1100（赋值节点）、1106（遍历节点（foreach））、1221（PyODPS 3）。', 'type' => 'string', 'required' => false, 'example' => '10,23'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '文件责任人'."\n"
.'。', 'type' => 'string', 'required' => false, 'example' => '3726346****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '调度节点的ID。'."\n"
.'您可以调用[ListNodes](~~173979~~)接口获取节点ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123541234'],
],
[
'name' => 'NeedContent',
'in' => 'formData',
'schema' => ['description' => '查询结果是否包含文件内容（对于内容较多的文件，'."\n"
.'可能存在较长的网络传输延时）。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'NeedAbsoluteFolderPath',
'in' => 'formData',
'schema' => ['description' => '查询结果是否包含文件所在的文件夹的路径'."\n"
.'。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ExactFileName',
'in' => 'formData',
'schema' => ['description' => '精确匹配的文件名称，'."\n"
.'查询结果的文件名称与该参数完全一致。', 'type' => 'string', 'required' => false, 'example' => 'ods_create.sql'],
],
[
'name' => 'FileIdIn',
'in' => 'formData',
'schema' => ['description' => 'Fileld列表，查询结果的文件ID集合只能是该列表的子集。'."\n"
.'最多支持一次指定50个FileId。', 'type' => 'string', 'required' => false, 'example' => '78237,816123'],
],
[
'name' => 'LastEditUser',
'in' => 'formData',
'schema' => ['description' => '文件最后更新人的阿里云ID。', 'type' => 'string', 'required' => false, 'example' => '11233***'],
],
[
'name' => 'CommitStatus',
'in' => 'formData',
'schema' => ['description' => '文件当前的提交状态，'."\n"
.'包括0（未提交最新的代码）和1（已提交最新的代码）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '返回数据详情'."\n"
.'。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '请求的数据页数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示的数据条数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '满足条件的数据总条数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
'Files' => [
'description' => '文件详情'."\n"
.'。',
'type' => 'array',
'items' => [
'description' => '文件信息'."\n"
.'。',
'type' => 'object',
'properties' => [
'CommitStatus' => ['description' => '文件当前的提交状态，包括0（未提交最新的代码）和1（已提交最新的代码）'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'AutoParsing' => ['description' => '文件是否开启自动解析功能。取值如下：'."\n"
."\n"
.'- true：文件会自动解析代码。'."\n"
.'- false：文件不会自动解析代码。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”选择“同周期”时的“代码解析”对应。', 'type' => 'boolean', 'example' => 'true'],
'Owner' => ['description' => '文件责任人的阿里云用户ID'."\n"
.'。', 'type' => 'string', 'example' => '3872572****'],
'CreateTime' => ['description' => '文件创建时间的毫秒时间戳'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000'],
'FileType' => ['description' => '文件类型。不同文件类型其代码不同，详情请参见[DataWorks节点合集](~~600169~~)'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'CurrentVersion' => ['description' => '当前文件的最新版本'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'BizId' => ['description' => '文件所属的业务流程ID。该字段已废弃，请使用BusinessId字段'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '300000'],
'LastEditUser' => ['description' => '文件最后更新人的阿里云ID'."\n"
.'。', 'type' => 'string', 'example' => '382762****'],
'FileName' => ['description' => '文件的名称'."\n"
.'。', 'type' => 'string', 'example' => 'ods_user_info_d'],
'ConnectionName' => ['description' => '文件对应的任务执行时所使用的数据源名称'."\n"
.'。', 'type' => 'string', 'example' => 'odps_source'],
'UseType' => ['description' => '文件所属的功能模块。'."\n"
.'取值如下：'."\n"
.'- NORMAL：数据开发。'."\n"
.'- MANUAL：手动任务。'."\n"
.'- MANUAL_BIZ：手动业务流程。'."\n"
.'- SKIP：数据开发的空跑调度。'."\n"
.'- ADHOCQUERY：临时查询。'."\n"
.'- COMPONENT：组件管理。', 'type' => 'string', 'example' => 'NORMAL'],
'FileFolderId' => ['description' => '文件所在文件夹的ID'."\n"
.'。', 'type' => 'string', 'example' => '2735c2****'],
'FileId' => ['description' => '文件的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001'],
'ParentId' => ['description' => '如果当前文件是组合节点文件的内部文件，该字段标识对应组合节点文件的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'],
'CreateUser' => ['description' => '文件创建者的阿里云用户ID'."\n"
.'。', 'type' => 'string', 'example' => '382762****'],
'IsMaxCompute' => ['description' => '如果当前文件是MaxCompute资源文件，该字段标识该资源文件是否需要上传至MaxCompute。'."\n"
."\n\n"
.'仅当文件是MaxCompute资源文件时才需要配置该参数。', 'type' => 'boolean', 'example' => 'false'],
'BusinessId' => ['description' => '文件所属的业务流程ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '300000'],
'FileDescription' => ['description' => '文件的描述信息'."\n"
.'。', 'type' => 'string', 'example' => 'my test datastudio file'],
'LastEditTime' => ['description' => '最近一次编辑文件的毫秒时间戳'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000'],
'Content' => ['description' => '该参数已废弃。您可通过[GetFile](~~173954~~)接口查询'."\n"
.'。', 'type' => 'string', 'example' => 'SHOW TABLES;'],
'NodeId' => ['description' => '提交文件后，在调度系统生成的调度任务的ID'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '300001'],
'AbsoluteFolderPath' => ['description' => '文件所在的文件夹的路径'."\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.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\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' => '查询文件列表',
'summary' => '调用ListFiles查询文件列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'ParentFolderPath',
'in' => 'formData',
'schema' => ['description' => '父文件夹的路径'."\n"
.'。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/my_first_business_process/MaxCompute'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '请求的数据页数，用于翻页'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的数据条数，默认为10条，最大为100条'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '满足条件的文件夹的列表信息'."\n"
.'。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '当前数据页的页码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '当前数据页的数据条数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '满足查询条件的数据总条数'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
'Folders' => [
'description' => '文件夹的列表'."\n"
.'。',
'type' => 'array',
'items' => [
'description' => '文件夹的信息'."\n"
.'。',
'type' => 'object',
'properties' => [
'FolderPath' => ['description' => '文件夹的路径'."\n"
.'。', 'type' => 'string', 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer'],
'FolderId' => ['description' => '文件夹的ID'."\n"
.'。', 'type' => 'string', 'example' => '2735c2****'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\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' => '查询文件夹的列表',
'summary' => '调用ListFolders查询文件夹的列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListFunctions' => [
'summary' => '调用此接口，可以分页获取数据开发中的udf函数列表，也可以使用筛选条件筛选udf函数。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => '筛选条件：udf函数的负责人ID', 'type' => 'string', 'required' => false, 'example' => '110755000425XXXX'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '筛选条件：函数类型'."\n"
."\n"
.'可选值：'."\n"
."\n\n"
.'- Math： 数学运算函数'."\n"
.'- Aggregate： 聚合函数'."\n"
.'- String：字符串处理函数'."\n"
.'- Date：日期函数'."\n"
.'- Analytic：窗口函数'."\n"
.'- Other： 其他函数',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Math',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '筛选条件：udf函数名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页的页数。默认值为1，最小值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的数据条数，默认为10条，最大为100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '89FB2BF0-EB00-5D03-9C34-05931001XXXX'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '294'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Functions' => [
'description' => '函数列表',
'type' => 'array',
'items' => [
'description' => '函数列表元素信息',
'type' => 'object',
'properties' => [
'Name' => ['title' => '资源名称', 'description' => 'udf函数名称', 'type' => 'string', 'deprecated' => false, 'example' => 'Function name', 'pattern' => '', 'default' => ''],
'CreateTime' => ['title' => '创建时间', 'description' => 'udf函数创建时间戳', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1655953028000', 'pattern' => '', 'default' => ''],
'ProjectId' => ['title' => '项目Id', 'description' => 'udf函数所在的项目ID', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '307XXX', 'pattern' => '', 'default' => ''],
'Owner' => ['title' => '责任人', 'description' => 'udf函数的责任人', 'type' => 'string', 'deprecated' => false, 'example' => '110755000425XXXX', 'pattern' => '', 'default' => ''],
'Type' => [
'title' => '函数类型',
'description' => 'udf函数类型'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Math： 数学运算函数'."\n"
.'- Aggregate： 聚合函数'."\n"
.'- String：字符串处理函数'."\n"
.'- Date：日期函数'."\n"
.'- Analytic：窗口函数'."\n"
.'- Other： 其他函数',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Math',
'pattern' => '',
'default' => '',
],
'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1655953028000'."\n", 'pattern' => '', 'default' => ''],
'ClassName' => ['title' => '函数实现类名', 'description' => 'udf函数的全限定类名', 'type' => 'string', 'deprecated' => false, 'example' => 'com.demo.Main', 'pattern' => '', 'default' => ''],
'ArmResource' => ['title' => 'ARM集群资源文件列表', 'description' => 'ARM集群资源文件列表', 'type' => 'string', 'deprecated' => false, 'example' => 'xxx.jar,yyy.jar', 'pattern' => '', 'default' => ''],
'FileResource' => ['title' => '函数的实现代码', 'description' => '函数的实现代码，资源文件列表', 'type' => 'string', 'deprecated' => false, 'example' => 'xxx.jar,yyy.jar', 'pattern' => '', 'default' => ''],
'Description' => ['title' => '描述', 'description' => '对于函数的总体描述', 'type' => 'string', 'deprecated' => false, 'example' => 'Description', 'pattern' => '', 'default' => ''],
'CommandDescription' => ['title' => '命令描述', 'description' => '命令描述', 'type' => 'string', 'deprecated' => false, 'example' => 'testUdf(xx,yy)', 'pattern' => '', 'default' => ''],
'ParameterDescription' => ['title' => '命令描述', 'description' => '参数描述', 'type' => 'string', 'deprecated' => false, 'example' => 'xx: parameter information XXX'."\n"
.'yy: parameter information YYY', 'pattern' => '', 'default' => ''],
'ReturnValueDescription' => ['title' => '返回值说明', 'description' => '返回值说明', 'type' => 'string', 'deprecated' => false, 'example' => 'The return value is a string.', 'pattern' => '', 'default' => ''],
'ExampleDescription' => ['title' => '示例说明', 'description' => '示例说明', 'type' => 'string', 'deprecated' => false, 'example' => 'Example description >>> select tsetUdf(xx,yy);'."\n"
.'abc', 'pattern' => '', 'default' => ''],
'EmbeddedCodeType' => [
'title' => '嵌套代码类型',
'description' => '嵌套代码类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Python2'."\n"
.'- Python3'."\n"
.'- Java8'."\n"
.'- Java11'."\n"
.'- Java17',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Python2',
'pattern' => '',
'default' => '',
],
'EmbeddedResourceType' => [
'title' => '嵌套资源类型',
'description' => '嵌套资源类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- File 普通资源文件'."\n"
.'- Embedded 嵌入式资源',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'File',
'pattern' => '',
'default' => '',
],
'EmbeddedCode' => ['title' => '嵌套函数代码内容', 'description' => '嵌套函数代码内容', 'type' => 'string', 'deprecated' => false, 'example' => 'print(\'hello,world!\')', 'pattern' => '', 'default' => ''],
'DatabaseName' => ['title' => '数据库名', 'description' => '数据库名，仅当Function类型为EMR Function时使用', 'type' => 'string', 'deprecated' => false, 'example' => 'EMR_lake', 'pattern' => '', 'default' => ''],
'DataSource' => [
'title' => '数据源',
'description' => 'udf函数数据源信息',
'type' => 'object',
'properties' => [
'Name' => ['title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'deprecated' => false, 'example' => 'odps_first', 'pattern' => '', 'default' => ''],
'Type' => ['title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'deprecated' => false, 'example' => 'odps', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Script' => [
'title' => '脚本信息',
'description' => 'udf函数脚本信息',
'type' => 'object',
'properties' => [
'Path' => ['title' => '脚本路径', 'description' => '脚本路径', 'type' => 'string', 'deprecated' => false, 'example' => 'XXX/OpenAPI/function/function_name', 'pattern' => '', 'default' => ''],
'Runtime' => [
'title' => '运行时',
'description' => '运行时',
'type' => 'object',
'properties' => [
'Command' => ['title' => '命令', 'description' => '命令', 'type' => 'string', 'deprecated' => false, 'example' => 'ODPS_FUNCTION', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '脚本id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '652567824470354XXXX'],
],
'deprecated' => false,
'required' => false,
],
'RuntimeResource' => [
'title' => '运行时资源组信息',
'description' => '运行时资源组信息',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['title' => '运行时资源组Id', 'description' => '运行时资源组Id', 'type' => 'string', 'deprecated' => false, 'example' => 'S_resgrop_xxx', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => 'udf函数唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'example' => '580667964888595XXXX'],
],
],
],
],
],
],
],
],
],
'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' => '获取数据开发函数列表',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListImageAssociatedProjects' => [
'summary' => '查询镜像关联的工作空间列表。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245182',
'abilityTreeNodes' => ['FEATUREdide2SV6DS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'Data' => [
'title' => '关联的工作空间ID列表',
'description' => '关联的工作空间ID列表',
'type' => 'array',
'items' => ['title' => '项目ID', 'description' => '项目ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100000001'],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询镜像关联的工作空间列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": [\\n 100000001\\n ],\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'ListImageVersions' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245169',
'abilityTreeNodes' => ['FEATUREdide2SV6DS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页列表',
'description' => '分页列表',
'type' => 'object',
'properties' => [
'ImageVersions' => [
'title' => '获取到的镜像版本详情列表',
'description' => '获取到的镜像版本详情列表',
'type' => 'array',
'items' => [
'title' => '镜像版本详细信息',
'description' => '镜像版本详细信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'example' => 'Custom_image_xxxx_xxxx'],
'Name' => ['title' => '镜像名称', 'description' => '镜像名称', 'type' => 'string', 'example' => 'dataworks_image'],
'Version' => ['title' => '镜像版本', 'description' => '镜像版本', 'type' => 'string', 'example' => '1'],
'Description' => ['title' => '镜像描述', 'description' => '镜像描述', 'type' => 'string', 'example' => 'Test image created by xxx'],
'Creator' => ['title' => '创建人', 'description' => '创建人 ID', 'type' => 'string', 'example' => '123'],
'Modifier' => ['title' => '修改人', 'description' => '修改人 ID', 'type' => 'string', 'example' => '123'],
'CreatedTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'LastModifiedTime' => ['title' => '最后修改时间，为64位时间戳', 'description' => '最后修改时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'Official' => ['title' => '是否为官方镜像', 'description' => '是否为官方镜像', 'type' => 'boolean', 'example' => 'true'],
'Accessibility' => ['title' => '可访问性', 'description' => '可访问性：'."\n"
.'- Public：全员可见；'."\n"
.'- Private：仅创建者可见。', 'type' => 'string', 'example' => 'Public'],
'Status' => ['title' => '镜像状态', 'description' => '镜像状态：'."\n"
.'- Disabled：禁用；'."\n"
.'- Expired：过期；'."\n"
.'- Available：可用；'."\n"
.'- ReadOnly：只读。', 'type' => 'string', 'example' => 'Available'],
'PublishStage' => ['title' => '发布阶段', 'description' => '发布状态：'."\n"
.'- Untest：未测试；'."\n"
.'- Testing：测试中；'."\n"
.'- TestFailed：测试失败；'."\n"
.'- Unpublished：未发布；'."\n"
.'- Publishing：发布中；'."\n"
.'- Published：已发布；'."\n"
.'- PublishFailed：发布失败；'."\n"
.'- Building：构建中；'."\n"
.'- BuildSuccess：构建成功；'."\n"
.'- BuildFailed：构建失败；'."\n"
.'- Accelerating：加速中；'."\n"
.'- AccelerateSuccess：加速成功；'."\n"
.'- AccelerateFailed：加速失败。', 'type' => 'string', 'example' => 'Published'],
'Supported' => [
'title' => '支持的模块和任务类型',
'description' => '支持的模块和任务类型',
'type' => 'object',
'properties' => [
'Module' => ['title' => '支持的模块', 'description' => '支持的模块：'."\n"
.'- Scheduler：调度。', 'type' => 'string', 'example' => 'Scheduler'],
'TaskTypes' => [
'title' => '支持的任务类型列表',
'description' => '支持的任务类型列表',
'type' => 'array',
'items' => ['title' => '支持的任务类型', 'description' => '支持的任务类型：'."\n"
.'- Shell'."\n"
.'- Python'."\n"
.'- ServerIDE'."\n"
.'- Notebook'."\n"
.'- PyODPS 2'."\n"
.'- PyODPS 3', 'type' => 'string', 'example' => 'Shell'],
],
],
],
'IsDefault' => ['title' => '是否为默认镜像', 'description' => '是否为默认镜像', 'type' => 'boolean', 'example' => 'false'],
'EnableSyncMaxCompute' => ['title' => '是否启用同步MaxCompute', 'description' => '是否启用同步MaxCompute', 'type' => 'boolean', 'example' => 'false'],
'ProviderType' => ['title' => '提供者类型', 'description' => '镜像引用类型：'."\n"
.'- ACR：ACR镜像仓库；'."\n"
.'- DataWorks：DataWorks官方镜像。', 'type' => 'string', 'example' => 'ACR'],
'ProviderImageId' => ['title' => '提供者镜像ID', 'description' => '镜像提供方镜像 ID', 'type' => 'string', 'example' => 'acr_image_id'],
'ImageUri' => ['title' => '镜像URI', 'description' => '镜像URI', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag'],
'Namespace' => ['title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'example' => 'namespace'],
'Size' => ['title' => '镜像大小', 'description' => '镜像大小', 'type' => 'string', 'example' => '1GB'],
'AcrInstanceId' => ['title' => 'ACR实例ID', 'description' => 'ACR实例ID', 'type' => 'string', 'example' => 'cri-xxx'],
'ImageTag' => ['title' => '镜像标签', 'description' => '镜像标签', 'type' => 'string', 'example' => 'v1.0.0'],
'RepositoryName' => ['title' => '仓库名称', 'description' => '仓库名称', 'type' => 'string', 'example' => 'repo_name'],
'ImageVpcUri' => ['title' => '镜像VPC URI', 'description' => '镜像VPC URI', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag'],
'AcrEndpoint' => ['title' => 'ACR端点', 'description' => 'ACR Endpoint', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com'],
'AcrAssociatedVpcId' => ['title' => 'ACR关联的VPC ID', 'description' => 'ACR 实例关联专有网络 ID', 'type' => 'string', 'example' => 'vpc-xxx'],
'BuildConfig' => [
'description' => '镜像构建配置',
'type' => 'object',
'properties' => [
'BuildType' => ['description' => '构建类型', 'type' => 'string', 'example' => 'PackageInstallation'],
'PackageInstallationScripts' => [
'description' => '预安装执行脚本列表',
'type' => 'array',
'items' => [
'description' => '预安装执行脚本',
'type' => 'object',
'properties' => [
'Type' => ['description' => '脚本类型', 'type' => 'string', 'example' => 'Python3'],
'Content' => ['description' => '脚本内容，若为安装包名称则以英文逗号分隔', 'type' => 'string', 'example' => 'requests'],
],
],
],
],
],
],
],
],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
'TotalCount' => ['title' => '全部数据条目', 'description' => '全部数据条目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取指定镜像版本详情',
'summary' => '获取指定镜像版本详情。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"ImageVersions\\": [\\n {\\n \\"Id\\": \\"Custom_image_xxxx_xxxx\\",\\n \\"Name\\": \\"dataworks_image\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"Test image created by xxx\\",\\n \\"Creator\\": \\"123\\",\\n \\"Modifier\\": \\"123\\",\\n \\"CreatedTime\\": 1727055811000,\\n \\"LastModifiedTime\\": 1727055811000,\\n \\"Official\\": true,\\n \\"Accessibility\\": \\"Public\\",\\n \\"Status\\": \\"Available\\",\\n \\"PublishStage\\": \\"Published\\",\\n \\"Supported\\": {\\n \\"Module\\": \\"Scheduler\\",\\n \\"TaskTypes\\": [\\n \\"Shell\\"\\n ]\\n },\\n \\"IsDefault\\": false,\\n \\"EnableSyncMaxCompute\\": false,\\n \\"ProviderType\\": \\"ACR\\",\\n \\"ProviderImageId\\": \\"acr_image_id\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"Size\\": \\"1GB\\",\\n \\"AcrInstanceId\\": \\"cri-xxx\\",\\n \\"ImageTag\\": \\"v1.0.0\\",\\n \\"RepositoryName\\": \\"repo_name\\",\\n \\"ImageVpcUri\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"AcrEndpoint\\": \\"registry.cn-hangzhou.aliyuncs.com\\",\\n \\"AcrAssociatedVpcId\\": \\"vpc-xxx\\",\\n \\"BuildConfig\\": {\\n \\"BuildType\\": \\"PackageInstallation\\",\\n \\"PackageInstallationScripts\\": [\\n {\\n \\"Type\\": \\"Python3\\",\\n \\"Content\\": \\"requests\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'ListImages' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245169',
'abilityTreeNodes' => ['FEATUREdide2SV6DS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '镜像名称，用于模糊查询', 'description' => '镜像名称，用于模糊查询', 'type' => 'string', 'required' => false, 'example' => 'image'],
],
[
'name' => 'Statuses',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '查询的镜像状态列表',
'description' => '查询的镜像状态列表',
'type' => 'array',
'items' => [
'title' => '镜像状态',
'description' => '镜像状态：'."\n"
.'- Disabled：禁用；'."\n"
.'- Expired：过期；'."\n"
.'- Available：可用；'."\n"
.'- ReadOnly：只读。',
'type' => 'string',
'required' => false,
'example' => 'Enabled',
'enum' => ['Disabled', 'Expired', 'Available', 'ReadOnly'],
],
'required' => false,
],
],
[
'name' => 'Stages',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '查询的镜像发布阶段列表',
'description' => '查询的镜像发布阶段列表',
'type' => 'array',
'items' => [
'title' => '镜像发布阶段',
'description' => '发布状态：'."\n"
.'- Untest：未测试；'."\n"
.'- Testing：测试中；'."\n"
.'- TestFailed：测试失败；'."\n"
.'- Unpublished：未发布；'."\n"
.'- Publishing：发布中；'."\n"
.'- Published：已发布；'."\n"
.'- PublishFailed：发布失败；'."\n"
.'- Building：构建中；'."\n"
.'- BuildSuccess：构建成功；',
'type' => 'string',
'required' => false,
'example' => 'Published',
'enum' => ['Untest', 'Testing', 'TestFailed', 'Unpublished', 'Publishing', 'Published', 'PublishFailed', 'Building', 'BuildSuccess', 'BuildFailed', 'Accelerating', 'AccelerateSuccess', 'AccelerateFailed'],
],
'required' => false,
],
],
[
'name' => 'Accessibility',
'in' => 'query',
'schema' => [
'title' => '镜像可访问性',
'description' => '可访问性：'."\n"
.'- Public：全员可见；'."\n"
.'- Private：仅创建者可见。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Public',
],
],
[
'name' => 'ProjectIds',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '工作空间ID列表',
'description' => '工作空间ID列表',
'type' => 'array',
'items' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'],
'required' => false,
],
],
[
'name' => 'SupportedModules',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '支持的模块列表',
'description' => '支持的模块列表',
'type' => 'array',
'items' => [
'title' => '支持的模块',
'description' => '支持的模块：'."\n"
.'- Scheduler：调度。',
'type' => 'string',
'required' => false,
'example' => 'Scheduler',
'enum' => ['Scheduler'],
],
'required' => false,
],
],
[
'name' => 'SupportedTaskTypes',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '支持的任务类型列表',
'description' => '支持的任务类型列表',
'type' => 'array',
'items' => ['title' => '支持的任务类型', 'description' => '支持的任务类型：'."\n"
.'- Shell'."\n"
.'- Python'."\n"
.'- ServerIDE'."\n"
.'- Notebook'."\n"
.'- PyODPS 2'."\n"
.'- PyODPS 3', 'type' => 'string', 'required' => false, 'example' => 'Shell'],
'required' => false,
],
],
[
'name' => 'ProviderTypes',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '镜像提供者类型列表',
'description' => '镜像引用类型列表',
'type' => 'array',
'items' => [
'title' => '镜像提供者类型',
'description' => '镜像引用类型：'."\n"
."\n"
.'- ACR：ACR镜像仓库；'."\n"
.'- DataWorks：DataWorks官方镜像。',
'type' => 'string',
'required' => false,
'example' => 'ACR',
'enum' => ['ACR', 'DataWorks', 'PAI', 'MaxCompute'],
],
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['title' => '排序字段列表，格式为"排序字段+排序方式。排序字段的枚举值如下：\\n● CreatedTime (Desc/Asc)：创建时间\\n● Name (Desc/Asc)：镜像名称\\n默认值为CreatedTime Desc', 'description' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
.'- CreateTime (Desc/Asc)：创建时间；'."\n"
.'- Name (Desc/Asc)：镜像名称。'."\n"
.'默认值为CreateTime Asc', 'type' => 'string', 'required' => false, 'example' => 'CreatedTime Desc', 'default' => 'CreatedTime Desc'],
],
[
'name' => 'SearchAll',
'in' => 'query',
'schema' => ['title' => '是否搜索所有镜像', 'description' => '是否搜索所有镜像', 'type' => 'boolean', 'required' => false, 'default' => 'false'],
],
[
'name' => 'Official',
'in' => 'query',
'schema' => ['title' => '是否为官方镜像', 'description' => '是否为官方镜像', 'type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页列表',
'description' => '分页列表',
'type' => 'object',
'properties' => [
'ImageList' => [
'title' => '获取到的镜像详情列表',
'description' => '获取到的镜像详情列表',
'type' => 'array',
'items' => [
'title' => '镜像详细信息',
'description' => '镜像详细信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '镜像ID', 'description' => '镜像ID', 'type' => 'string', 'example' => 'Custom_image_xxxx_xxxx'],
'Name' => ['title' => '镜像名称', 'description' => '镜像名称', 'type' => 'string', 'example' => 'dataworks_image'],
'Version' => ['title' => '镜像版本', 'description' => '镜像版本', 'type' => 'string', 'example' => '1'],
'Description' => ['title' => '镜像描述', 'description' => '镜像描述', 'type' => 'string', 'example' => 'Test image created by xxx'],
'Creator' => ['title' => '创建人', 'description' => '创建人 ID', 'type' => 'string', 'example' => '123'],
'Modifier' => ['title' => '修改人', 'description' => '修改人 ID', 'type' => 'string', 'example' => '123'],
'CreatedTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'LastModifiedTime' => ['title' => '最后修改时间，为64位时间戳', 'description' => '最后修改时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'Official' => ['title' => '是否为官方镜像', 'description' => '是否为官方镜像', 'type' => 'boolean', 'example' => 'true'],
'Accessibility' => [
'title' => '可访问性',
'description' => '可访问性：'."\n"
.'- Public：全员可见；'."\n"
.'- Private：仅创建者可见。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Public',
'enum' => ['Tenant', 'Project', 'Public'],
],
'Status' => [
'title' => '镜像状态',
'description' => '镜像状态：'."\n"
.'- Disabled：禁用；'."\n"
.'- Expired：过期；'."\n"
.'- Available：可用；'."\n"
.'- ReadOnly：只读。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Available',
],
'PublishStage' => [
'title' => '发布阶段',
'description' => '发布状态：'."\n"
.'- Untest：未测试；'."\n"
.'- Testing：测试中；'."\n"
.'- TestFailed：测试失败；'."\n"
.'- Unpublished：未发布；'."\n"
.'- Publishing：发布中；'."\n"
.'- Published：已发布；'."\n"
.'- PublishFailed：发布失败；'."\n"
.'- Building：构建中；'."\n"
.'- BuildSuccess：构建成功；'."\n"
.'- BuildFailed：构建失败；'."\n"
.'- Accelerating：加速中；'."\n"
.'- AccelerateSuccess：加速成功；'."\n"
.'- AccelerateFailed：加速失败。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Published',
],
'Supported' => [
'title' => '支持的模块和任务类型',
'description' => '支持的模块和任务类型',
'type' => 'object',
'properties' => [
'Module' => ['title' => '支持的模块', 'description' => '支持的模块：'."\n"
.'- Scheduler：调度。', 'type' => 'string', 'example' => 'Scheduler'],
'TaskTypes' => [
'title' => '支持的任务类型列表',
'description' => '支持的任务类型列表',
'type' => 'array',
'items' => ['title' => '支持的任务类型', 'description' => '支持的任务类型：'."\n"
.'- Shell'."\n"
.'- Python'."\n"
.'- ServerIDE'."\n"
.'- Notebook'."\n"
.'- PyODPS 2'."\n"
.'- PyODPS 3', 'type' => 'string', 'example' => 'Shell'],
],
],
],
'IsDefault' => ['title' => '是否为默认镜像', 'description' => '是否为默认镜像', 'type' => 'boolean', 'example' => 'false'],
'EnableSyncMaxCompute' => ['title' => '是否启用同步MaxCompute', 'description' => '是否启用同步MaxCompute', 'type' => 'boolean', 'example' => 'false'],
'ProviderType' => ['title' => '提供者类型', 'description' => '镜像引用类型：'."\n"
.'- ACR：ACR镜像仓库；'."\n"
.'- DataWorks：DataWorks官方镜像。', 'type' => 'string', 'example' => 'ACR'],
'ProviderImageId' => ['title' => '提供者镜像ID', 'description' => '镜像提供方镜像 ID', 'type' => 'string', 'example' => 'acr_image_id'],
'ImageUri' => ['title' => '镜像URI', 'description' => '镜像URI', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag'],
'Namespace' => ['title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'example' => 'namespace'],
'Size' => ['title' => '镜像大小', 'description' => '镜像大小', 'type' => 'string', 'example' => '1GB'],
'AcrInstanceId' => ['title' => 'ACR实例ID', 'description' => 'ACR实例ID', 'type' => 'string', 'example' => 'cri-xxx'],
'ImageTag' => ['title' => '镜像标签', 'description' => '镜像标签', 'type' => 'string', 'example' => 'v1.0.0'],
'RepositoryName' => ['title' => '仓库名称', 'description' => '仓库名称', 'type' => 'string', 'example' => 'repo_name'],
'ImageVpcUri' => ['title' => '镜像VPC URI', 'description' => '镜像VPC URI', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag'],
'AcrEndpoint' => ['title' => 'ACR端点', 'description' => 'ACR Endpoint', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com'],
'AcrAssociatedVpcId' => ['title' => 'ACR关联的VPC ID', 'description' => 'ACR 实例关联专有网络 ID', 'type' => 'string', 'example' => 'vpc-xxx'],
'BuildConfig' => [
'description' => '镜像构建配置',
'type' => 'object',
'properties' => [
'BuildType' => ['description' => '构建类型', 'type' => 'string', 'example' => 'PackageInstallation'],
'PackageInstallationScripts' => [
'description' => '预安装执行脚本列表',
'type' => 'array',
'items' => [
'description' => '预安装执行脚本',
'type' => 'object',
'properties' => [
'Type' => ['description' => '脚本类型', 'type' => 'string', 'example' => 'Python3'],
'Content' => ['description' => '脚本内容，若为安装包名称则以英文逗号分隔', 'type' => 'string', 'example' => 'requests'],
],
],
],
],
],
],
],
],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'],
'TotalCount' => ['title' => '全部数据条目', 'description' => '全部数据条目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取镜像列表',
'summary' => '获取镜像列表。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"ImageList\\": [\\n {\\n \\"Id\\": \\"Custom_image_xxxx_xxxx\\",\\n \\"Name\\": \\"dataworks_image\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"Test image created by xxx\\",\\n \\"Creator\\": \\"123\\",\\n \\"Modifier\\": \\"123\\",\\n \\"CreatedTime\\": 1727055811000,\\n \\"LastModifiedTime\\": 1727055811000,\\n \\"Official\\": true,\\n \\"Accessibility\\": \\"Public\\",\\n \\"Status\\": \\"Available\\",\\n \\"PublishStage\\": \\"Published\\",\\n \\"Supported\\": {\\n \\"Module\\": \\"Scheduler\\",\\n \\"TaskTypes\\": [\\n \\"Shell\\"\\n ]\\n },\\n \\"IsDefault\\": false,\\n \\"EnableSyncMaxCompute\\": false,\\n \\"ProviderType\\": \\"ACR\\",\\n \\"ProviderImageId\\": \\"acr_image_id\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"Size\\": \\"1GB\\",\\n \\"AcrInstanceId\\": \\"cri-xxx\\",\\n \\"ImageTag\\": \\"v1.0.0\\",\\n \\"RepositoryName\\": \\"repo_name\\",\\n \\"ImageVpcUri\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"AcrEndpoint\\": \\"registry.cn-hangzhou.aliyuncs.com\\",\\n \\"AcrAssociatedVpcId\\": \\"vpc-xxx\\",\\n \\"BuildConfig\\": {\\n \\"BuildType\\": \\"PackageInstallation\\",\\n \\"PackageInstallationScripts\\": [\\n {\\n \\"Type\\": \\"Python3\\",\\n \\"Content\\": \\"requests\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'ListLineageRelationships' => [
'summary' => '查询数据地图给定两实体（表、字段、oss文件等）之间的血缘关系信息列表。',
'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' => '源实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
[
'name' => 'DstEntityId',
'in' => 'query',
'schema' => ['description' => '目标实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID', 'type' => 'string', 'required' => true, 'example' => 'dlf-table::catalog_id:database_name::table_name'],
],
[
'name' => 'SrcEntityName',
'in' => 'query',
'schema' => ['title' => '名称', 'description' => '源实体名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'srcName'],
],
[
'name' => 'DstEntityName',
'in' => 'query',
'schema' => ['description' => '目标实体名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'dstName'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为Name',
'description' => '排序字段，默认为Name。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Name',
'default' => 'Name',
'enum' => ['Name'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持：'."\n"
."\n"
.'- Asc：升序'."\n"
.'- Desc：降序',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位排查问题。', 'type' => 'string', 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页结果',
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'PageNumber' => ['description' => '页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'LineageRelationships' => [
'title' => '数据表列表',
'description' => '数据表列表。',
'type' => 'array',
'items' => ['description' => '血缘关系结构体。', '$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:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询数据地图血缘关系列表',
'description' => '1. 需要购买DataWorks标准版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListLineageRelationships',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListLineages' => [
'summary' => '查询数据地图中给定实体的上下游血缘实体列表，是否包含具体的血缘关系信息可选。',
'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' => '源实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID。', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
[
'name' => 'DstEntityId',
'in' => 'query',
'schema' => ['description' => '目标实体ID，可参考ListTables / ListColumns 接口返回的表/字段ID，以及自定义实体ID。', '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' => '是否返回血缘关系信息，默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为Name',
'description' => '排序字段，默认为Name，按照血缘实体名称排序。',
'type' => 'string',
'required' => false,
'example' => 'Name',
'default' => 'Name',
'enum' => ['Name'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n"
.'- Asc 升序'."\n"
.'- Desc 降序',
'type' => 'string',
'required' => false,
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100。', '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' => '请求'."\n"
.'ID。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页结果',
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条'."\n"
.'数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'PageNumber' => ['description' => '请求的数据页数，'."\n"
.'用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小，'."\n"
.'默认为10。', '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:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Relationships\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询数据地图实体血缘列表',
'description' => '1. 需要购买DataWorks标准版及以上版本才能使用。'."\n"
.'2. 本接口主要查询当前实体有哪些上/下游实体，以及实体间的血缘关系',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListLineages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListMcpServers' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Q',
'in' => 'formData',
'schema' => ['description' => '搜索关键词，按 MCP Server 名称模糊匹配。'."\n", 'type' => 'string', 'required' => false, 'example' => 'mcp'],
],
[
'name' => 'Visibility',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '按可见性级别过滤，可传多个。'."\n",
'type' => 'array',
'items' => [
'description' => '可见性级别。可选值：TENANT（账号内可见）、PROJECT（指定项目可见）、USER（指定用户可见）。',
'type' => 'string',
'required' => false,
'example' => 'TENANT',
'enum' => ['TENANT', 'PROJECT', 'USER'],
],
'required' => false,
'example' => '-',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '本次请求返回的最大条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '分页 Token。首次查询不传；后续查询传上一次返回的 NextToken 获取下一页。'."\n", 'type' => 'string', 'required' => false, 'example' => '12345'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数对象。'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '符合条件的总条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'McpServers' => [
'description' => 'MCP Server 列表。'."\n",
'type' => 'array',
'items' => [
'description' => '-',
'type' => 'object',
'properties' => [
'CreatorId' => ['description' => '创建者 ID。'."\n", 'type' => 'string', 'example' => '805298765622151'],
'ModifierId' => ['description' => '最近修改者 ID。'."\n", 'type' => 'string', 'example' => '123456'],
'Name' => ['description' => 'MCP Server 名称。'."\n", 'type' => 'string', 'example' => 'my-mcp-server'],
'Config' => [
'description' => 'MCP Server 连接配置。'."\n",
'type' => 'object',
'properties' => [
'Url' => ['description' => 'MCP Server 服务地址。'."\n", 'type' => 'string', 'example' => 'https://example.com/mcp/sse'],
'Transport' => ['description' => '传输协议。'."\n", 'type' => 'string', 'example' => 'SSE'],
'CustomHeaders' => ['description' => '自定义请求头。'."\n", 'type' => 'object', 'example' => '{}'],
],
],
'Visibility' => ['description' => '**可见性级别。**'."\n", 'type' => 'string', 'example' => 'TENANT'],
'GmtCreateTime' => ['description' => '**创建时间（毫秒时间戳）。**'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'GmtModifiedTime' => ['description' => '**最近修改时间（毫秒时间戳）。**'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
],
],
'MaxResults' => ['description' => '**本次返回的最大条数。**'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['description' => '**下一页 Token，为空表示已到末页。**'."\n", 'type' => 'string', 'example' => '2'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '分页列出 MCP Server',
'summary' => '分页列出 MCP Server',
'description' => '## 请求说明'."\n"
."\n"
.'该API用于分页查询当前账号下的所有MCP Server列表。支持通过搜索关键词、可见性级别过滤以及设置最大返回条数和分页Token来获取特定的MCP Server信息。'."\n"
."\n"
.'- **Q**: 可选参数，用于按MCP Server名称进行模糊匹配搜索。'."\n"
.'- **Visibility**: 可选参数，允许传入多个值以按可见性级别（如`TENANT`、`PROJECT`或`USER`）过滤结果。'."\n"
.'- **MaxResults**: 可选参数，指定本次请求返回的最大条数，默认不限制。'."\n"
.'- **NextToken**: 可选参数，用于分页查询时传递上一次请求返回的NextToken值以获取下一页数据。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"McpServers\\": [\\n {\\n \\"CreatorId\\": \\"805298765622151\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"Config\\": {\\n \\"Url\\": \\"https://example.com/mcp/sse\\",\\n \\"Transport\\": \\"SSE\\",\\n \\"CustomHeaders\\": {}\\n },\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n ],\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"2\\"\\n }\\n}","type":"json"}]',
],
'ListMetaCollections' => [
'summary' => '查询数据地图集合列表，支持查询数据地图类目以及数据专辑两种类型。',
'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' => '集合类型，可枚举，取值为'."\n"
."\n"
.' - Category 类目'."\n"
.' - Album 数据专辑'."\n"
.' - AlbumCategory 专辑子类目',
'type' => 'string',
'required' => true,
'example' => 'Category',
'enum' => ['Category', 'Album', 'AlbumCategory'],
],
],
[
'name' => 'ParentId',
'in' => 'query',
'schema' => ['description' => '父节点集合对象ID。', 'type' => 'string', 'required' => false, 'example' => 'as78d756asd'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '集合名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '集合描述，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'Test collection'],
],
[
'name' => 'CreateUser',
'in' => 'query',
'schema' => ['description' => '创建者用户ID，专辑类型有效，默认为当前用户ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'Administrator',
'in' => 'query',
'schema' => ['description' => '集合管理员ID，专辑类型有效，默认为当前用户ID。', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '排序字段, 支持'."\n"
."\n"
.' - Id（默认）'."\n"
.' - Name 名称'."\n"
.' - CreateUser 创建者ID'."\n"
.' - CreateTime 创建时间'."\n"
.' - ModifyTime 修改时间', 'type' => 'string', 'required' => false, 'example' => 'Name'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排序方向，支持'."\n"
."\n"
.' - Asc（默认）'."\n"
.' - Desc', 'type' => 'string', 'required' => false, 'example' => 'Asc'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小，默认为10，最大为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E25887B7-XXXX-54A5-9C4F-83A0DE367DDE'],
'Data' => [
'title' => '分页结果',
'description' => '分页结果对象。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'MetaCollections' => [
'description' => '集合列表。',
'type' => 'array',
'items' => [
'description' => '集合对象。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '集合对象名称。', 'type' => 'string', 'example' => 'test_category'],
'Id' => ['description' => '集合对象名称。', 'type' => 'string', 'example' => '7a65sd7aasd'],
'ParentId' => ['description' => '父节点集合对象Id，可为空。', 'type' => 'string', 'example' => 'as78d756asd'],
'Description' => ['description' => '集合对象描述。', 'type' => 'string', 'example' => 'Test category'],
'Type' => ['description' => '集合类型，可枚举，取值为'."\n"
."\n"
.' - Category 类目'."\n"
.' - Album 数据专辑'."\n"
.' - AlbumCategory 专辑子类目', 'type' => 'string', 'example' => 'Category'],
'CreateUser' => ['description' => '创建者用户ID。', 'type' => 'string', 'example' => '456789'],
'CreateTime' => ['description' => '创建时间毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000'],
'ModifyTime' => ['description' => '修改时间毫秒级时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000'],
'Administrators' => [
'description' => '管理员用户ID列表，仅专辑类型支持，'."\n"
.'需要为同租户下用户，可设置多个。',
'type' => 'array',
'items' => ['description' => '管理员用户ID。', '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\\": \\"Test category\\",\\n \\"Type\\": \\"Category\\",\\n \\"CreateUser\\": \\"456789\\",\\n \\"CreateTime\\": 1668568601000,\\n \\"ModifyTime\\": 1668568601000,\\n \\"Administrators\\": [\\n \\"765432\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询数据地图集合列表',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListMetaEntities' => [
'summary' => '查询元数据实体列表-当前仅支持纯自定义类型',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'EntityType',
'in' => 'formData',
'schema' => ['title' => '实体类型，支持 custom_entity-{name} 和 custom_{name}-{database|table|column}', 'description' => '实体类型', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
'schema' => ['title' => '每页返回的最大结果数，默认为10，最大100', 'description' => '每页返回的最大结果数，默认为10，最大100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'NextToken',
'in' => 'formData',
'schema' => ['title' => '下一页游标，首次请求不传，后续请求使用上一次返回的NextToken', 'description' => '下一页游标，首次请求不传，后续请求使用上一次返回的NextToken', 'type' => 'string', 'required' => false, 'example' => 'AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '实体名称过滤', 'description' => '实体名称过滤，关键词包含匹配', 'type' => 'string', 'required' => false, 'example' => 'xm_create_test'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '注释过滤', 'description' => '注释过滤，分词匹配', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
],
[
'name' => 'AttributeFilters',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '实体属性过滤条件，多个过滤条件之间为AND关系，同一过滤条件内多个值为OR关系',
'description' => '实体属性过滤条件，多个过滤条件之间为AND关系，同一过滤条件内多个值为OR关系',
'type' => 'array',
'items' => [
'description' => '实体属性过滤',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤属性Key', 'description' => '过滤属性Key', 'type' => 'string', 'required' => true, 'example' => 'key1'],
'Values' => [
'title' => '过滤属性值列表',
'description' => '过滤属性值列表',
'type' => 'array',
'items' => ['description' => '过滤属性值', 'type' => 'string', 'required' => false, 'example' => 'value1'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
'example' => '[]',
],
],
[
'name' => 'CustomAttributeFilters',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '自定义属性过滤条件，仅支持精确自定义实体类型和ENUM自定义属性',
'description' => '自定义属性过滤条件，多个过滤条件之间为AND关系，同一过滤条件内多个值为OR关系,仅支持ENUM自定义属性',
'type' => 'array',
'items' => [
'description' => '自定义属性过滤',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤属性Key', 'description' => '过滤属性Key', 'type' => 'string', 'required' => true, 'example' => 'custom_attr_1'],
'Values' => [
'title' => '过滤属性值列表',
'description' => '过滤属性值列表',
'type' => 'array',
'items' => ['description' => '过滤属性值', 'type' => 'string', 'required' => false, 'example' => 'value1'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
'example' => '[]',
],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => [
'title' => '排序字段',
'description' => '排序字段',
'type' => 'string',
'required' => false,
'example' => 'Name',
'default' => 'CreateTime',
'enum' => ['Name', 'CreateTime', 'ModifyTime'],
],
],
[
'name' => 'Order',
'in' => 'formData',
'schema' => [
'title' => '排序方向',
'description' => '排序方向',
'type' => 'string',
'required' => false,
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页信息',
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'MaxResults' => ['title' => '每页返回的最大结果数', 'description' => '每页返回的最大结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'NextToken' => ['title' => '下一页游标', 'description' => '下一页游标', 'type' => 'string', 'example' => 'AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc='],
'MetaEntities' => [
'title' => '自定义实体列表',
'description' => '自定义实体列表',
'type' => 'array',
'items' => ['description' => '自定义实体对象', '$ref' => '#/components/schemas/MetaEntity'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询元数据实体列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=\\",\\n \\"MetaEntities\\": [\\n {\\n \\"Id\\": \\"custom_entity-customer_api:api_001\\",\\n \\"EntityType\\": \\"custom_entity-customer_api\\",\\n \\"Name\\": \\"api_001\\",\\n \\"Comment\\": \\"this is a comment\\",\\n \\"OwnerId\\": \\"207924799988354\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"MetaEntityDef\\": {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n },\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1763380628000,\\n \\"Attributes\\": {\\n \\"key\\": \\"v1\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListMetaEntityDefs' => [
'summary' => '查询自定义实体定义列表（包括自定义实体类型和扩展表类型）。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['title' => '分页大小，默认为10，最大100', 'description' => '分页大小，默认为10，最大100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['title' => '类型定义展示名称，按普通文本包含匹配', 'description' => '类型定义展示名称，按普通文本包含匹配', 'type' => 'string', 'required' => false, 'example' => 'CustomReport'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '描述，模糊匹配', 'description' => '描述，模糊匹配', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
[
'name' => 'Extend',
'in' => 'formData',
'schema' => [
'title' => '扩展模式过滤，支持 NONE、TABLE',
'description' => '扩展模式过滤，支持 NONE、TABLE',
'type' => 'string',
'required' => false,
'example' => 'NONE',
'enum' => ['NONE', 'TABLE'],
],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => [
'title' => '排序字段，支持 Name、CreateTime、ModifyTime',
'description' => '排序字段，支持 Name、CreateTime、ModifyTime',
'type' => 'string',
'required' => false,
'example' => 'CreateTime',
'default' => 'CreateTime',
'enum' => ['Name', 'CreateTime', 'ModifyTime'],
],
],
[
'name' => 'Order',
'in' => 'formData',
'schema' => [
'title' => '排序方向，支持 Asc、Desc',
'description' => '排序方向，支持 Asc、Desc',
'type' => 'string',
'required' => false,
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页信息',
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'MetaEntityDefs' => [
'title' => '自定义实体定义列表',
'description' => '自定义实体定义列表',
'type' => 'array',
'items' => ['description' => '自定义实体定义', '$ref' => '#/components/schemas/MetaEntityDef'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询元数据实体定义列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MetaEntityDefs\\": [\\n {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListMyApplications' => [
'summary' => '用于查询当前用户发起的所有资源访问权限申请单。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'DefSchema',
'in' => 'formData',
'schema' => ['description' => '根据资源类型筛选。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute'],
],
[
'name' => 'ResourceType',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据最小权限资源类型筛选。'."\n"
."\n"
.'注意：最小权限资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions). resources[*].isValidLeaf 为true 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'array',
'items' => ['description' => '资源类型', 'type' => 'string', 'required' => false, 'example' => 'table'],
'required' => true,
'maxItems' => 5,
],
],
[
'name' => 'Resource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据资源做精确/泛化筛选，资源的描述受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions) 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'DefSchema' => ['description' => '资源类型。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'],
'DefVersion' => ['description' => '资源解析版本受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version约束。'."\n"
."\n"
.'[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'v1.0.0', 'default' => 'v1.0.0'],
'MetaData' => [
'description' => '资源元数据。'."\n"
."\n"
.'注意：元数据受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources 约束，有效的资源声明需要包含level 0到validLeaf层的全路径元数据声明。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "workspace": "449056",'."\n"
.' "project": "sync_destination"'."\n"
.' }', 'description' => '资源元数据'],
],
],
'required' => false,
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '申请时间开始（毫秒时间戳）'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1771948800000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '申请时间结束（毫秒时间戳）'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1779724799999'],
],
[
'name' => 'Statuses',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回',
'type' => 'array',
'items' => ['description' => '资源状态', 'type' => 'string', 'required' => false, 'example' => 'WAIT_APPROVAL'],
'required' => false,
'example' => 'Deleted',
'maxItems' => 3,
'minItems' => 0,
],
],
[
'name' => 'NextToken',
'in' => 'formData',
'schema' => ['description' => '游标'."\n", 'type' => 'string', 'required' => false, 'example' => 'eyJpZCI6MTIzfQ=='],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页大小（默认10，最大200）'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '20', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '分页结果'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID，uuid生成'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
'Data' => [
'description' => '分页结果中的数据部分'."\n",
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页大小（默认10，最大200）'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'NextToken' => ['description' => '游标'."\n", 'type' => 'string', 'example' => 'eyJpZCI6NDU2fQ=='],
'HasMore' => ['description' => '是否有更多数据'."\n", 'type' => 'boolean', 'example' => 'false'],
'Data' => [
'description' => '申请单详情列表'."\n",
'type' => 'array',
'items' => [
'description' => '审批流程与申请内容',
'type' => 'object',
'properties' => [
'ProcessInstanceId' => ['description' => '流程实例ID'."\n", 'type' => 'string', 'example' => '176906667488145'],
'DefSchema' => ['description' => '资源类型'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'Reason' => ['description' => '申请理由'."\n", 'type' => 'string', 'example' => '业务需要'],
'ApplicationTime' => ['description' => '申请发起时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1779695088000'],
'Status' => ['description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回', 'type' => 'string', 'example' => 'Deleted'],
'Contents' => [
'description' => '申请内容',
'type' => 'array',
'items' => [
'description' => '申请内容',
'type' => 'object',
'properties' => [
'Id' => ['description' => '申请内容主键'."\n", 'type' => 'string', 'example' => 'a8aa620037bb410ea13837f9b4d053d8'],
'ProcessInstanceId' => ['description' => '发起申请的审批流程实例ID'."\n", 'type' => 'string', 'example' => '777799223'],
'TenantId' => ['description' => '租户ID'."\n", 'type' => 'string', 'example' => '69973837489'],
'ResourceName' => ['description' => '最小权限资源类型'."\n", 'type' => 'string', 'example' => 'table'],
'DefSchema' => ['description' => '资源类型'."\n", 'type' => 'string', 'example' => 'MAXCOMPUTE'],
'AuthMethod' => ['description' => '授权方式', 'type' => 'string', 'example' => 'default'],
'Resource' => [
'description' => '**资源声明**'."\n",
'type' => 'object',
'properties' => [
'DefSchema' => ['description' => '**资源解析依赖的ResourceSchema.name**'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'DefVersion' => ['description' => '**资源解析依赖的ResourceSchema.version**'."\n", 'type' => 'string', 'example' => 'v1.0.0'],
'MetaData' => [
'description' => '**资源元数据，数据内容受ResourceSchema约束**'."\n",
'type' => 'object',
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "schema": "default",'."\n"
.' "threeTierModel": false,'."\n"
.' "project": "sync_dtestn",'."\n"
.' "workspace": "4477656",'."\n"
.' "table": "order",'."\n"
.' "tenant": "524257424864736"'."\n"
.' }'."\n", 'description' => '资源内容'],
],
],
],
'Grantee' => [
'description' => '**授权对象**'."\n",
'type' => 'object',
'properties' => [
'PrincipalType' => ['description' => '授权主体类型：'."\n"
.'- RamRole'."\n"
.'- RamUser'."\n"
.'- DataworksTenantMember'."\n"
.'- DataworksTenantRole'."\n"
.'- DataworksProjectMember'."\n"
.'- DataworksProjectRole'."\n"
.'- DlfRole'."\n", 'type' => 'string', 'example' => 'RamRole'],
'PrincipalId' => ['description' => '授权主体ID：'."\n"
.'- RamUser：Dataworks UserId'."\n"
.'- RamRole："ROLE_"开头的Dataworks UserId'."\n"
.'- DataworksTenantMember：Dataworks UserId'."\n"
.'- DataworksTenantRole：Dataworks tenant roleCode'."\n"
.'- DataworksProjectRole：Dataworks workspace roleCode'."\n"
.'- DataworksProjectMember：Dataworks UserId'."\n"
.'- DlfRole：DlfNext role name'."\n", 'type' => 'string', 'example' => 'ROLE_3133343434'],
],
],
'AccessTypes' => [
'description' => '发起申请的资源操作权限'."\n",
'type' => 'array',
'items' => ['description' => '权限', 'type' => 'string', 'example' => 'select'],
],
'FinalAccessTypes' => [
'description' => '最终审批通过的资源操作权限'."\n",
'type' => 'array',
'items' => ['description' => '权限', 'type' => 'string', 'example' => 'select'],
],
'ExpirationTime' => ['description' => '权限截止日期，毫秒时间戳'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1782354014507'],
'Status' => ['description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回', 'type' => 'string', 'example' => 'Deleted'],
'CreateTime' => ['description' => '创建时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-11-29 15:04:52'],
'UpdateTime' => ['description' => '更新时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-07-08 23:58:59'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询我发起的权限申请单',
'description' => '## 请求说明'."\n"
.'- 该接口支持分页查询，通过`NextToken`和`PageSize`参数控制。'."\n"
.'- `DefSchema`为必填项，指定资源类型。'."\n"
.'- `ResourceType`列表中可以包含多个资源类型，用于更精确地筛选申请单。'."\n"
.'- 可以通过设置`StartTime`和`EndTime`来限制查询的时间范围。'."\n"
.'- `Statuses`允许过滤特定状态下的申请单，如待审批、已授权等。'."\n"
.'- 如果需要根据具体的资源或授权对象进行筛选，可以通过`Resource`和`Grantee`字段提供详细信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"NextToken\\": \\"eyJpZCI6NDU2fQ==\\",\\n \\"HasMore\\": false,\\n \\"Data\\": [\\n {\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 1779695088000,\\n \\"Status\\": \\"Deleted\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"a8aa620037bb410ea13837f9b4d053d8\\",\\n \\"ProcessInstanceId\\": \\"777799223\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MAXCOMPUTE\\",\\n \\"AuthMethod\\": \\"default\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"schema\\\\\\": \\\\\\"default\\\\\\",\\\\n \\\\\\"threeTierModel\\\\\\": false,\\\\n \\\\\\"project\\\\\\": \\\\\\"sync_dtestn\\\\\\",\\\\n \\\\\\"workspace\\\\\\": \\\\\\"4477656\\\\\\",\\\\n \\\\\\"table\\\\\\": \\\\\\"order\\\\\\",\\\\n \\\\\\"tenant\\\\\\": \\\\\\"524257424864736\\\\\\"\\\\n }\\\\n\\"\\n }\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamRole\\",\\n \\"PrincipalId\\": \\"ROLE_3133343434\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1782354014507,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListMyRelatedApprovals' => [
'summary' => '查询当前用户作为审批人或相关方的所有权限申请单。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'DefSchema',
'in' => 'formData',
'schema' => ['description' => '根据资源类型筛选。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute'],
],
[
'name' => 'ResourceType',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据最小权限资源类型筛选。'."\n"
."\n"
.'注意：最小权限资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions). resources[*].isValidLeaf 为true 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'array',
'items' => ['description' => '资源类型', 'type' => 'string', 'required' => false, 'example' => 'project'],
'required' => true,
'example' => '["table", "column"]',
'maxItems' => 5,
],
],
[
'name' => 'Resource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据资源做精确/泛化筛选，资源的描述受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions) 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'DefSchema' => ['description' => '资源类型。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'],
'DefVersion' => ['description' => '资源解析版本受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version约束。'."\n"
."\n"
.'[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'v1.0.0', 'default' => 'v1.0.0'],
'MetaData' => [
'description' => '资源元数据。'."\n"
."\n"
.'注意：元数据受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources 约束，有效的资源声明需要包含level 0到validLeaf层的全路径元数据声明。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "workspace": "449056",'."\n"
.' "project": "sync_destination"'."\n"
.' }', 'description' => '资源元数据'],
],
],
'required' => false,
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '申请时间开始（毫秒时间戳）'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1771948800000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '申请时间结束（毫秒时间戳）'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1779724799999'],
],
[
'name' => 'Statuses',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回',
'type' => 'array',
'items' => ['description' => '审批状态', 'type' => 'string', 'required' => false, 'example' => 'Deleted'],
'required' => false,
'example' => 'WAIT_APPROVAL',
],
],
[
'name' => 'Grantee',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据授权主体筛选。 '."\n"
."\n"
.'注意：系统支持的授权主体类型受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'PrincipalType' => ['description' => '授权主体类型：'."\n"
."\n"
.'- `RamRole`'."\n"
.'- `RamUser`'."\n"
.'- `DataworksTenantMember`'."\n"
.'- `DataworksTenantRole`'."\n"
.'- `DataworksProjectMember`'."\n"
.'- `DataworksProjectRole`'."\n"
.'- `DlfRole`'."\n", 'type' => 'string', 'required' => false, 'example' => 'RamRole'],
'PrincipalId' => ['description' => '授权主体ID：'."\n"
."\n"
.'- `RamUser`：Dataworks UserId'."\n"
.'- `RamRole`："ROLE_"开头的Dataworks UserId'."\n"
.'- `DataworksTenantMember`：Dataworks UserId'."\n"
.'- `DataworksTenantRole`：Dataworks tenant roleCode'."\n"
.'- `DataworksProjectRole`：Dataworks workspace roleCode'."\n"
.'- `DataworksProjectMember`：Dataworks UserId'."\n"
.'- `DlfRole`：DlfNext role name'."\n", 'type' => 'string', 'required' => false, 'example' => 'ROLE_3133343434'],
],
'required' => false,
],
],
[
'name' => 'AccessTypes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据申请的权限筛选。'."\n"
."\n"
.'注意：不同层级资源支持权限的申请类型不同，统一受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf和accessTypeRestrictions和authMethodAccessTypes 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'array',
'items' => ['description' => '权限', 'type' => 'string', 'required' => false, 'example' => 'select'],
'required' => false,
],
],
[
'name' => 'NextToken',
'in' => 'formData',
'schema' => ['description' => '游标'."\n", 'type' => 'string', 'required' => false, 'example' => 'eyJpZCI6MTIzfQ=='],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页大小（默认10，最大200）'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '20', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID，uuid生成'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
'Data' => [
'description' => '分页结果',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页大小（默认10，最大200）'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'NextToken' => ['description' => '游标'."\n", 'type' => 'string', 'example' => 'eyJpZCI6NDU2fQ=='],
'HasMore' => ['description' => '是否有更多数据'."\n", 'type' => 'boolean', 'example' => 'false'],
'Data' => [
'description' => '申请单详情'."\n",
'type' => 'array',
'items' => [
'description' => '审批流程与申请内容',
'type' => 'object',
'properties' => [
'ProcessInstanceId' => ['description' => '流程实例ID'."\n", 'type' => 'string', 'example' => '176906667488145'],
'DefSchema' => ['description' => '资源类型'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'Reason' => ['description' => '申请理由'."\n", 'type' => 'string', 'example' => '业务需要'],
'ApplicationTime' => ['description' => '申请发起时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1779695088000'],
'Status' => ['description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回', 'type' => 'string', 'example' => 'Deleted'],
'Contents' => [
'description' => '申请内容',
'type' => 'array',
'items' => [
'description' => '申请内容',
'type' => 'object',
'properties' => [
'Id' => ['description' => '申请内容唯一标识', 'type' => 'string', 'example' => '1009516415'],
'ProcessInstanceId' => ['description' => '发起申请的审批流程实例ID'."\n", 'type' => 'string', 'example' => '777799223'],
'TenantId' => ['description' => '租户ID'."\n", 'type' => 'string', 'example' => '69973837489'],
'ResourceName' => ['description' => '最小权限资源类型'."\n", 'type' => 'string', 'example' => 'table'],
'DefSchema' => ['description' => '资源类型'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'AuthMethod' => ['description' => '授权方式'."\n", 'type' => 'string', 'example' => 'default'],
'Resource' => [
'description' => '资源声明'."\n",
'type' => 'object',
'properties' => [
'DefSchema' => ['description' => '资源解析依赖的ResourceSchema.name'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'DefVersion' => ['description' => '资源解析依赖的ResourceSchema.version'."\n", 'type' => 'string', 'example' => 'v1.0.0'],
'MetaData' => [
'description' => '资源元数据，数据内容受ResourceSchema约束'."\n",
'type' => 'object',
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "schema": "default",'."\n"
.' "threeTierModel": false,'."\n"
.' "project": "sync_dtestn",'."\n"
.' "workspace": "4477656",'."\n"
.' "table": "order",'."\n"
.' "tenant": "524257424864736"'."\n"
.' }', 'description' => '资源内容'],
],
],
],
'Grantee' => [
'description' => '授权对象'."\n",
'type' => 'object',
'properties' => [
'PrincipalType' => ['description' => '主体类型，枚举：'."\n"
."\n"
.'- RamRole'."\n"
.'- RamUser'."\n"
.'- DataworksTenantMember'."\n"
.'- DataworksTenantRole'."\n"
.'- DataworksProjectMember'."\n"
.'- DataworksProjectRole'."\n"
.'- DlfRole', 'type' => 'string', 'example' => 'RamRole'],
'PrincipalId' => ['description' => '主体 ID。'."\n"
."\n"
.'注意：当 principalType 为不同类型时，对应不同语义：'."\n"
."\n"
.'- RamUser：Dataworks UserId'."\n"
.'- RamRole："ROLE_"开头的 Dataworks UserId'."\n"
.'- DataworksTenantMember：Dataworks UserId'."\n"
.'- DataworksTenantRole：Dataworks tenant roleCode'."\n"
.'- DataworksProjectRole：Dataworks workspace roleCode'."\n"
.'- DataworksProjectMember：Dataworks UserId'."\n"
.'- DlfRole：DlfNext role name', 'type' => 'string', 'example' => 'ROLE_3133343434'],
],
],
'AccessTypes' => [
'description' => '发起申请的资源操作权限'."\n",
'type' => 'array',
'items' => ['description' => '权限', 'type' => 'string', 'example' => 'select'],
],
'FinalAccessTypes' => [
'description' => '最终审批通过的资源操作权限'."\n",
'type' => 'array',
'items' => ['description' => '权限', 'type' => 'string', 'example' => 'select'],
],
'ExpirationTime' => ['description' => '权限截止日期，毫秒时间戳'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1779695088000'],
'Status' => ['description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回', 'type' => 'string', 'example' => 'Deleted'],
'CreateTime' => ['description' => '创建时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-11 10:13:21'],
'UpdateTime' => ['description' => '更新时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2024-03-05 18:24:13'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询与我相关的权限申请单',
'description' => '## 请求说明'."\n"
.'- 该接口用于获取当前用户作为审批人的所有权限申请单，包括待审批和已审批的申请单。'."\n"
.'- 可以通过`Statuses`参数筛选特定状态的申请单。'."\n"
.'- `NextToken`用于分页请求，首次请求时可以不传或传`null`，后续请求需要传递上一次响应中的`NextToken`值。'."\n"
.'- `PageSize`默认为10，最大支持200。'."\n"
.'- `DefSchema`和`ResourceType`是必填项，其他参数可根据需求选择性填写。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"NextToken\\": \\"eyJpZCI6NDU2fQ==\\",\\n \\"HasMore\\": false,\\n \\"Data\\": [\\n {\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 1779695088000,\\n \\"Status\\": \\"Deleted\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"1009516415\\",\\n \\"ProcessInstanceId\\": \\"777799223\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"AuthMethod\\": \\"default\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"schema\\\\\\": \\\\\\"default\\\\\\",\\\\n \\\\\\"threeTierModel\\\\\\": false,\\\\n \\\\\\"project\\\\\\": \\\\\\"sync_dtestn\\\\\\",\\\\n \\\\\\"workspace\\\\\\": \\\\\\"4477656\\\\\\",\\\\n \\\\\\"table\\\\\\": \\\\\\"order\\\\\\",\\\\n \\\\\\"tenant\\\\\\": \\\\\\"524257424864736\\\\\\"\\\\n }\\"\\n }\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamRole\\",\\n \\"PrincipalId\\": \\"ROLE_3133343434\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1779695088000,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListNetworks' => [
'summary' => '获取资源组网络资源列表。',
'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' => '通用资源组唯一标识', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003****'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页页码', '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' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
."\n"
.'- Id (Desc/Asc)：网络ID'."\n"
.'- Status (Desc/Asc)：网络状态'."\n"
.'- CreateUser (Desc/Asc)：创建用户'."\n"
.'- CreateTime (Desc/Asc)：创建时间'."\n"
."\n"
.'默认值为CreateTime Asc', 'type' => 'string', 'required' => false, 'example' => 'CreateTime Asc', 'default' => 'CreateTime Asc'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'PagingInfo' => [
'title' => '分页列表',
'description' => '分页列表',
'type' => 'object',
'properties' => [
'NetworkList' => [
'title' => '获取到的通用资源组网络资源详细信息列表',
'description' => '获取到的通用资源组网络资源详细信息列表',
'type' => 'array',
'items' => [
'title' => '网络资源详细信息',
'description' => '网络资源详细信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '网络资源ID', 'description' => '网络资源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'ResourceGroupId' => ['title' => '所属通用资源组的唯一标识', 'description' => '所属通用资源组的唯一标识', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
'VpcId' => ['title' => '网络资源的VPC ID', 'description' => '网络资源的VPC ID', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX'],
'VswitchId' => ['title' => '网络资源的交换机ID', 'description' => '网络资源的交换机ID', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX'],
'SecurityGroupId' => ['title' => '网络资源组的安全组ID', 'description' => '网络资源组的安全组ID', 'type' => 'string', 'example' => 'sg-2ze13vamugr7jenXXXXX'],
'Status' => [
'title' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除',
'description' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Running',
'enum' => ['Pending', 'Running', 'Deleting', 'Deleted', 'Creating'],
],
'CreateUser' => ['title' => '创建该网络资源的用户ID', 'description' => '创建该网络资源的用户ID', 'type' => 'string', 'example' => '11075500042XXXXX'],
'CreateTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
],
],
],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100'],
'TotalCount' => ['title' => '全部数据条目', 'description' => '全部数据条目', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', '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' => '获取资源组网络资源列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListNodeDependencies' => [
'summary' => '分页获取指定数据开发节点的依赖节点。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用于确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始。默认值为1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'string', 'example' => '90'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'string', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'string', 'example' => '1'],
'Nodes' => [
'description' => '查询到的依赖节点列表',
'type' => 'array',
'items' => [
'description' => '依赖节点列表元素',
'type' => 'object',
'properties' => [
'Description' => ['title' => '描述', 'description' => '节点描述信息', 'type' => 'string', 'example' => 'Node description'],
'Name' => ['title' => '节点名', 'description' => '数据开发节点名称', 'type' => 'string', 'example' => 'Node name'],
'ProjectId' => ['description' => '数据开发节点所属的项目空间ID', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '65133'],
'Owner' => ['title' => '责任人', 'description' => '数据开发节点的责任人', 'type' => 'string', 'deprecated' => false, 'example' => '110755000425XXXX', 'pattern' => '', 'default' => ''],
'CreateTime' => ['title' => '创建时间', 'description' => '数据开发节点的创建时间戳', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1724505917000', 'pattern' => '', 'default' => ''],
'ModifyTime' => ['title' => '修改时间', 'description' => '数据开发节点的最近修改时间戳', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1724505917000', 'pattern' => '', 'default' => ''],
'DataSource' => [
'title' => '数据源',
'description' => '数据源',
'type' => 'object',
'properties' => [
'Name' => ['title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'deprecated' => false, 'example' => 'odps_first', 'pattern' => '', 'default' => ''],
'Type' => ['title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'deprecated' => false, 'example' => 'odps', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'TaskId' => ['title' => '调度任务Id', 'description' => '调度任务Id', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '580667964888595XXXX', 'pattern' => '', 'default' => ''],
'Tags' => [
'title' => '标签信息',
'description' => '标签信息，暂未使用',
'type' => 'array',
'items' => [
'title' => '单个标签',
'description' => '单个标签信息，暂未使用',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'deprecated' => false, 'example' => 'null', 'pattern' => '', 'default' => ''],
'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'deprecated' => false, 'example' => 'null', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'deprecated' => false,
],
'Strategy' => [
'title' => '调度策略',
'description' => '调度策略',
'type' => 'object',
'properties' => [
'Timeout' => ['title' => '超时时间', 'description' => '超时时间，单位为毫秒', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '0', 'pattern' => '', 'default' => ''],
'InstanceMode' => [
'title' => '生成实例的模式',
'description' => '生成实例的模式'."\n"
.'- T+1'."\n"
.'- Immediately',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'T+1',
'pattern' => '',
'default' => '',
'enum' => ['T+1', 'Immediately'],
],
'RerunMode' => [
'title' => '允许重跑的模式',
'description' => '允许重跑的模式'."\n"
.'- Allowed'."\n"
.'- Denied'."\n"
.'- FailureAllowed',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Allowed',
'pattern' => '',
'default' => '',
'enum' => ['Allowed', 'Denied', 'FailureAllowed'],
],
'RerunTimes' => ['title' => '重试次数', 'description' => '失败后的重试次数', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '3', 'pattern' => '', 'default' => ''],
'RerunInterval' => ['title' => '重试时间间隔', 'description' => '失败后重试时间间隔，单位毫秒', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '180000', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Outputs' => [
'title' => '节点输出',
'description' => '节点输出',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => '变量列表',
'description' => '变量列表',
'type' => 'array',
'items' => [
'title' => '变量元素',
'description' => '变量元素',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名', 'description' => '变量名', 'type' => 'string', 'deprecated' => false, 'example' => 'output', 'pattern' => '', 'default' => ''],
'ArtifactType' => ['title' => '制品类型', 'description' => '制品类型', 'type' => 'string', 'deprecated' => false, 'example' => 'Variable', 'pattern' => '', 'default' => ''],
'Scope' => [
'title' => '范围',
'description' => '变量作用范围'."\n"
.'- NodeParameter'."\n"
.'- NodeContext'."\n"
.'- Workflow'."\n"
.'- Workspace',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'NodeParameter',
'pattern' => '',
'default' => '',
],
'Type' => [
'title' => '类型',
'description' => '变量类型'."\n"
.'- NoKvVariableExpression'."\n"
.'- Constant'."\n"
.'- PassThrough'."\n"
.'- System'."\n"
.'- NodeOutput',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Constant',
'pattern' => '',
'default' => '',
],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'deprecated' => false, 'example' => '111', 'pattern' => '', 'default' => ''],
'Node' => [
'title' => '变量所属节点',
'description' => '变量所属节点',
'type' => 'object',
'properties' => [
'Output' => ['title' => '节点输出', 'description' => '变量对应的节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '463497880880954XXXX', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '变量id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '543217824470354XXXX'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'NodeOutputs' => [
'title' => '节点输出列表',
'description' => '节点输出列表',
'type' => 'array',
'items' => [
'title' => '节点输出项',
'description' => '节点输出项',
'type' => 'object',
'properties' => [
'Data' => ['title' => '节点输出', 'description' => '节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '463497880880954XXXX', 'pattern' => '', 'default' => ''],
'RefTableName' => ['description' => '用于标识节点产出的目标数据表。该字段旨在提供易于理解的语义化名称，帮助用户快速识别输出内容，仅用于展示和备注，无实际逻辑约束。', 'type' => 'string', 'example' => 'testProject.testTableName'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'Tables' => [
'title' => '表列表',
'description' => '表列表',
'type' => 'array',
'items' => [
'title' => '表输出项',
'description' => '表输出项',
'type' => 'object',
'properties' => [
'Guid' => ['title' => '表id', 'description' => '表id', 'type' => 'string', 'deprecated' => false, 'example' => 'odps.autotest.test_output_table_1', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'deprecated' => false,
],
],
'deprecated' => false,
],
'Inputs' => [
'title' => '节点输入',
'description' => '节点输入',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => '变量列表',
'description' => '变量列表',
'type' => 'array',
'items' => [
'title' => '变量元素',
'description' => '变量元素',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名', 'description' => '变量名', 'type' => 'string', 'deprecated' => false, 'example' => 'input', 'pattern' => '', 'default' => ''],
'ArtifactType' => ['title' => '制品类型', 'description' => '制品类型', 'type' => 'string', 'deprecated' => false, 'example' => 'Variable', 'pattern' => '', 'default' => ''],
'Scope' => [
'title' => '范围',
'description' => '范围'."\n"
.'- NodeParameter'."\n"
.'- NodeContext'."\n"
.'- Workflow'."\n"
.'- Workspace',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'NodeParameter',
'pattern' => '',
'default' => '',
],
'Type' => [
'title' => '类型',
'description' => '类型'."\n"
.'- NoKvVariableExpression'."\n"
.'- Constant'."\n"
.'- PassThrough'."\n"
.'- System'."\n"
.'- NodeOutput',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Constant',
'pattern' => '',
'default' => '',
],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'deprecated' => false, 'example' => '111', 'pattern' => '', 'default' => ''],
'Node' => [
'title' => '变量所属节点',
'description' => '变量所属节点',
'type' => 'object',
'properties' => [
'Output' => ['title' => '节点输出', 'description' => '节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '860438872620113XXXX', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '变量id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '543218872620113XXXX'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'NodeOutputs' => [
'title' => '节点输出列表',
'description' => '节点输出列表',
'type' => 'array',
'items' => [
'title' => '节点输出项',
'description' => '节点输出项',
'type' => 'object',
'properties' => [
'Data' => ['title' => '节点输出', 'description' => '节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '860438872620113XXXX', 'pattern' => '', 'default' => ''],
'RefTableName' => ['description' => '用于标识节点产出的目标数据表。该字段旨在提供易于理解的语义化名称，帮助用户快速识别输出内容，仅用于展示和备注，无实际逻辑约束。', 'type' => 'string', 'example' => 'testProject.testTableName'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'Tables' => [
'title' => '表列表',
'description' => '表列表',
'type' => 'array',
'items' => [
'title' => '表输出项',
'description' => '表输出项',
'type' => 'object',
'properties' => [
'Guid' => ['title' => '表id', 'description' => '表id', 'type' => 'string', 'deprecated' => false, 'example' => 'odps.autotest.test_output_table_1', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'deprecated' => false,
],
],
'deprecated' => false,
],
'Trigger' => [
'title' => '触发器',
'description' => '触发器',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '类型',
'description' => '触发器类型'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Scheduler： 周期调度'."\n"
.'- Manual：手动调度'."\n"
.'- Streaming：流式调度器',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Scheduler',
'pattern' => '',
'default' => '',
],
'Cron' => ['title' => 'cron表达式', 'description' => '调度的cron表达式', 'type' => 'string', 'deprecated' => false, 'example' => '00 00 00 * * ?', 'pattern' => '', 'default' => ''],
'StartTime' => ['title' => '开始时间', 'description' => '调度有效的开始时间，格式为yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'deprecated' => false, 'example' => '1970-01-01 00:00:00', 'pattern' => '', 'default' => ''],
'EndTime' => ['title' => '结束时间', 'description' => '调度有效的结束时间，格式为yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'deprecated' => false, 'example' => '9999-01-01 00:00:00', 'pattern' => '', 'default' => ''],
'Timezone' => ['title' => '时区', 'description' => '时区', 'type' => 'string', 'deprecated' => false, 'example' => 'Asia/Shanghai', 'pattern' => '', 'default' => ''],
'Id' => ['description' => '触发器的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '543680677872062XXXX'],
],
'deprecated' => false,
],
'Script' => [
'title' => '脚本信息',
'description' => '脚本信息',
'type' => 'object',
'properties' => [
'Path' => ['title' => '脚本路径', 'description' => '脚本路径', 'type' => 'string', 'deprecated' => false, 'example' => 'root/demo', 'pattern' => '', 'default' => ''],
'Runtime' => [
'title' => '运行时',
'description' => '运行时',
'type' => 'object',
'properties' => [
'Command' => ['title' => '命令', 'description' => '命令，用于区分节点类型。', 'type' => 'string', 'deprecated' => false, 'example' => 'ODPS_SQL', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '脚本id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '853573334108680XXXX'],
],
'deprecated' => false,
'required' => false,
],
'RuntimeResource' => [
'title' => '资源组信息',
'description' => '资源组信息',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'deprecated' => false, 'example' => 'S_res_group_XXXX_XXXX', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Recurrence' => [
'description' => '调度类型'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Normal：正常执行任务。'."\n"
."\n"
.'- Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。'."\n"
."\n"
.'- Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为0秒），不会阻塞下游节点执行，也不会占用资源。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'Id' => ['description' => '数据开发节点唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', '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 \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"860438872620113XXXX\\"\\n },\\n \\"Id\\": \\"543218872620113XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"860438872620113XXXX\\",\\n \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_XXXX_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"723932906364267XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取数据开发节点的依赖节点',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListNodes' => [
'summary' => '分页获取数据开发节点列表，也可以通过筛选条件对列表进行筛选查询。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => [
'description' => '筛选条件：节点所在场景，如未指定则不填写，在数据开发中对应左侧目录树的分区可选值： '."\n"
."\n"
.'- DataworksProject 项目目录'."\n"
."\n"
.'- DataworksManualWorkflow 手动工作流 '."\n"
."\n"
.'- DataworksManualTask 手动任务。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'DataworksProject',
],
],
[
'name' => 'ContainerId',
'in' => 'query',
'schema' => ['description' => '如未指定则不填写，筛选条件：在指定容器内。填写容器ID，与资源组（ResourceGroupId）无关。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => false, 'example' => '860438872620113XXXX'],
],
[
'name' => 'Recurrence',
'in' => 'query',
'schema' => [
'description' => '筛选条件：调度类型可选值： '."\n"
."\n"
.'- Normal：正常执行任务。'."\n"
."\n"
.'- Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。'."\n"
.' '."\n"
.'- Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为0秒），不会阻塞下游节点执行，也不会占用资源。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
],
],
[
'name' => 'RerunMode',
'in' => 'query',
'schema' => [
'description' => '重跑属性，如不指定则不填写。取值如下： '."\n"
."\n"
.'- Allowed：运行成功或失败后皆可重跑。'."\n"
.' '."\n"
.'- FailureAllowed：运行成功后不可重跑，运行失败后可以重跑。'."\n"
.' '."\n"
.'- Denied：运行成功或失败皆不可重跑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Allowed',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '节点名称，支持模糊查询', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的id。用于定位日志，排查问题。', 'type' => 'string', 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'string', 'example' => '42'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'string', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'string', 'example' => '1'],
'Nodes' => [
'description' => '数据开发节点列表',
'type' => 'array',
'items' => [
'description' => '数据开发节点信息',
'type' => 'object',
'properties' => [
'Description' => ['title' => '描述', 'description' => '节点描述', 'type' => 'string', 'example' => 'Node description'."\n"],
'Name' => ['title' => '节点名', 'description' => '节点名称', 'type' => 'string', 'example' => 'test'],
'ProjectId' => ['description' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '33233'],
'Owner' => ['title' => '责任人', 'description' => '数据开发节点责任人', 'type' => 'string', 'deprecated' => false, 'example' => '110755000425XXXX', 'pattern' => '', 'default' => ''],
'CreateTime' => ['title' => '创建时间', 'description' => '数据开发节点创建时间戳', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1722910655000', 'pattern' => '', 'default' => ''],
'ModifyTime' => ['title' => '修改时间', 'description' => '数据开发节点最近修改时间戳', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1722910655000', 'pattern' => '', 'default' => ''],
'DataSource' => [
'title' => '数据源',
'description' => '数据源',
'type' => 'object',
'properties' => [
'Name' => ['title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'deprecated' => false, 'example' => 'odps_first', 'pattern' => '', 'default' => ''],
'Type' => ['title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'deprecated' => false, 'example' => 'odps', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'TaskId' => ['title' => '调度任务Id', 'description' => '调度任务Id', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '88888888888', 'pattern' => '', 'default' => ''],
'Tags' => [
'title' => '标签信息',
'description' => '标签信息，暂未使用',
'type' => 'array',
'items' => [
'title' => '单个标签',
'description' => '单个标签，暂未使用',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'deprecated' => false, 'example' => 'null', 'pattern' => '', 'default' => ''],
'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'deprecated' => false, 'example' => 'null', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'deprecated' => false,
],
'Strategy' => [
'title' => '调度策略',
'description' => '调度策略',
'type' => 'object',
'properties' => [
'Timeout' => ['title' => '超时时间', 'description' => '超时时间', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '0', 'pattern' => '', 'default' => ''],
'InstanceMode' => [
'title' => '生成实例的模式',
'description' => '生成实例的模式'."\n"
.'- T+1'."\n"
.'- Immediately',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'T+1',
'pattern' => '',
'default' => '',
'enum' => ['T+1', 'Immediately'],
],
'RerunMode' => [
'title' => '允许重跑的模式',
'description' => '允许重跑的模式'."\n"
.'- Allowed'."\n"
.'- Denied'."\n"
.'- FailureAllowed',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Allowed',
'pattern' => '',
'default' => '',
'enum' => ['Allowed', 'Denied', 'FailureAllowed'],
],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '3', 'pattern' => '', 'default' => ''],
'RerunInterval' => ['title' => '重试时间间隔', 'description' => '重试时间间隔，单位毫秒', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '180000', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Outputs' => [
'title' => '节点输出',
'description' => '节点输出',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => '变量列表',
'description' => '变量列表',
'type' => 'array',
'items' => [
'title' => '变量元素',
'description' => '变量元素',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名', 'description' => '变量名', 'type' => 'string', 'deprecated' => false, 'example' => 'output'."\n", 'pattern' => '', 'default' => ''],
'ArtifactType' => ['title' => '制品类型', 'description' => '制品类型', 'type' => 'string', 'deprecated' => false, 'example' => 'Variable', 'pattern' => '', 'default' => ''],
'Scope' => [
'title' => '范围',
'description' => '变量作用范围'."\n"
.'- NodeParameter'."\n"
.'- NodeContext'."\n"
.'- Workflow'."\n"
.'- Workspace',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'NodeParameter',
'pattern' => '',
'default' => '',
],
'Type' => [
'title' => '类型',
'description' => '变量类型'."\n"
.'- NoKvVariableExpression'."\n"
.'- Constant'."\n"
.'- PassThrough'."\n"
.'- System'."\n"
.'- NodeOutput',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Constant',
'pattern' => '',
'default' => '',
],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'deprecated' => false, 'example' => '111', 'pattern' => '', 'default' => ''],
'Node' => [
'title' => '变量所属节点',
'description' => '变量所属节点',
'type' => 'object',
'properties' => [
'Output' => ['title' => '节点输出', 'description' => '节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '860438872620113XXXX', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '变量id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '623731286945488XXXX'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'NodeOutputs' => [
'title' => '节点输出列表',
'description' => '节点输出列表',
'type' => 'array',
'items' => [
'title' => '节点输出项',
'description' => '节点输出项',
'type' => 'object',
'properties' => [
'Data' => ['title' => '节点输出', 'description' => '节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '860438872620113XXXX', 'pattern' => '', 'default' => ''],
'RefTableName' => ['description' => '用于标识节点产出的目标数据表。该字段旨在提供易于理解的语义化名称，帮助用户快速识别输出内容，仅用于展示和备注，无实际逻辑约束。', 'type' => 'string', 'example' => 'testProject.testTableName'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'Tables' => [
'title' => '表列表',
'description' => '表列表',
'type' => 'array',
'items' => [
'title' => '表输出项',
'description' => '表输出项',
'type' => 'object',
'properties' => [
'Guid' => ['title' => '表id', 'description' => '表id', 'type' => 'string', 'deprecated' => false, 'example' => 'odps.autotest.test_output_table_1', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'deprecated' => false,
],
],
'deprecated' => false,
],
'Inputs' => [
'title' => '节点输入',
'description' => '节点输入',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => '变量列表',
'description' => '变量列表',
'type' => 'array',
'items' => [
'title' => '变量元素',
'description' => '变量元素',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名', 'description' => '变量名', 'type' => 'string', 'deprecated' => false, 'example' => 'input', 'pattern' => '', 'default' => ''],
'ArtifactType' => ['title' => '制品类型', 'description' => '制品类型', 'type' => 'string', 'deprecated' => false, 'example' => 'Variable', 'pattern' => '', 'default' => ''],
'Scope' => [
'title' => '范围',
'description' => '输入变量作用范围'."\n"
.'- WorkSpace'."\n"
.'- NodeParameter'."\n"
.'- NodeContext'."\n"
.'- Workflow',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'NodeParameter',
'pattern' => '',
'default' => '',
],
'Type' => [
'title' => '类型',
'description' => '类型'."\n"
.'- NoKvVariableExpression'."\n"
.'- Constant'."\n"
.'- PassThrough'."\n"
.'- System'."\n"
.'- NodeOutput',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Constant',
'pattern' => '',
'default' => '',
],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'deprecated' => false, 'example' => '222', 'pattern' => '', 'default' => ''],
'Node' => [
'title' => '变量所属节点',
'description' => '变量所属节点',
'type' => 'object',
'properties' => [
'Output' => ['title' => '节点输出', 'description' => '节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '623731286945488XXXX', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '变量id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '543211286945488XXXX'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'NodeOutputs' => [
'title' => '节点输出列表',
'description' => '节点输出列表',
'type' => 'array',
'items' => [
'title' => '节点输出项',
'description' => '节点输出项',
'type' => 'object',
'properties' => [
'Data' => ['title' => '节点输出', 'description' => '节点输出', 'type' => 'string', 'deprecated' => false, 'example' => '623731286945488XXXX', 'pattern' => '', 'default' => ''],
'RefTableName' => ['description' => '用于标识节点产出的目标数据表。该字段旨在提供易于理解的语义化名称，帮助用户快速识别输出内容，仅用于展示和备注，无实际逻辑约束。', 'type' => 'string', 'example' => 'testProject.testTableName'],
],
'deprecated' => false,
],
'deprecated' => false,
],
'Tables' => [
'title' => '表列表',
'description' => '表列表',
'type' => 'array',
'items' => [
'title' => '表输出项',
'description' => '表输出项',
'type' => 'object',
'properties' => [
'Guid' => ['title' => '表id', 'description' => '表id', 'type' => 'string', 'deprecated' => false, 'example' => 'odps.autotest.test_output_table_1', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'deprecated' => false,
],
],
'deprecated' => false,
],
'Trigger' => [
'title' => '触发器',
'description' => '触发器',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '类型',
'description' => '触发器类型'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Scheduler 周期调度'."\n"
.'- Manual 手动触发'."\n"
.'- Steaming 流式任务',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => [],
'example' => 'Scheduler',
'pattern' => '',
'default' => '',
],
'Cron' => ['title' => 'cron表达式', 'description' => '调度的cron表达式', 'type' => 'string', 'deprecated' => false, 'example' => '00 00 00 * * ?', 'pattern' => '', 'default' => ''],
'StartTime' => ['title' => '开始时间', 'description' => '触发器有效期开始时间', 'type' => 'string', 'deprecated' => false, 'example' => '1970-01-01 00:00:00', 'pattern' => '', 'default' => ''],
'EndTime' => ['title' => '结束时间', 'description' => '触发器有效期结束时间', 'type' => 'string', 'deprecated' => false, 'example' => '9999-01-01 00:00:00', 'pattern' => '', 'default' => ''],
'Timezone' => ['title' => '时区', 'description' => '时区', 'type' => 'string', 'deprecated' => false, 'example' => 'Asia/Shanghai', 'pattern' => '', 'default' => ''],
'Id' => ['description' => '触发器id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '543680677872062XXXX'],
],
'deprecated' => false,
],
'Script' => [
'title' => '脚本信息',
'description' => '脚本信息',
'type' => 'object',
'properties' => [
'Path' => ['title' => '脚本路径', 'description' => '脚本路径', 'type' => 'string', 'deprecated' => false, 'example' => 'root/demo', 'pattern' => '', 'default' => ''],
'Runtime' => [
'title' => '运行时',
'description' => '运行时',
'type' => 'object',
'properties' => [
'Command' => ['title' => '命令', 'description' => '命令，用于区分节点类型。', 'type' => 'string', 'deprecated' => false, 'example' => 'ODPS_SQL', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '脚本id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '853573334108680XXXX'],
],
'deprecated' => false,
'required' => false,
],
'RuntimeResource' => [
'title' => '资源组信息',
'description' => '资源组信息',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['title' => '资源组id', 'description' => '资源组id', 'type' => 'string', 'deprecated' => false, 'example' => '123456XXX', 'pattern' => '', 'default' => ''],
'ResourceGroup' => ['description' => '资源组的标识（Identifier）。您可以调用[ListResourceGroups](~~173913~~)接口获取资源组的标识（Identifier）。', 'type' => 'string', 'example' => 'S_res_group_XXXX'],
],
'deprecated' => false,
],
'Recurrence' => [
'description' => '调度类型'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Normal：正常执行任务。'."\n"
."\n"
.'- Pause：节点状态被置为暂停，并且会阻塞依赖当前节点的下游节点执行。'."\n"
."\n"
.'- Skip：节点状态被置为空跑，系统会直接返回成功（执行时长为0秒），不会阻塞下游节点执行，也不会占用资源。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'Id' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', '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 \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"222\\",\\n \\"Node\\": {\\n \\"Output\\": \\"623731286945488XXXX\\"\\n },\\n \\"Id\\": \\"543211286945488XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"623731286945488XXXX\\",\\n \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"123456XXX\\",\\n \\"ResourceGroup\\": \\"S_res_group_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取数据开发节点列表',
'changeSet' => [
['createdAt' => '2025-04-02T02:48:34.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-13T07:48:25.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-10-11T02:17:18.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListParameterVersions' => [
'summary' => '查询参数版本列表。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => ['description' => '排序字段列表，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
.'- Version (Desc/Asc)', 'type' => 'string', 'required' => false, 'example' => 'Version Desc'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为20条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码数，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'PagingInfo' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageSize' => ['title' => '分页大小', 'description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'PageNumber' => ['title' => '页码', 'description' => '页码数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ParameterVersion' => [
'title' => '参数版本列表',
'description' => '参数版本列表',
'type' => 'array',
'items' => [
'title' => '参数版本信息',
'description' => '参数版本信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '参数ID', 'description' => '参数ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'workspace.para'],
'Type' => ['title' => '参数类型', 'description' => '类型。'."\n"
.'- PlainConstant 常量（明文）'."\n"
.'- SecretConstant 常量（密文）'."\n"
.'- Variable 变量', 'type' => 'string', 'example' => 'PlainConstant'],
'Scope' => ['title' => '参数范围', 'description' => '参数范围', 'type' => 'string', 'example' => 'Project'],
'ProjectId' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'Version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Description' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'This is a test parameter.'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000'],
'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000'],
'Owner' => ['title' => '责任人', 'description' => '责任人', 'type' => 'string', 'example' => '123456789'],
'CreateUser' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => '123456789'],
'ModifyUser' => ['title' => '修改人', 'description' => '修改人', 'type' => 'string', 'example' => '123456789'],
'Properties' => [
'title' => '参数值配置',
'description' => '参数值配置',
'type' => 'array',
'items' => [
'title' => '参数值配置项',
'description' => '参数值配置项',
'type' => 'object',
'properties' => [
'EnvType' => ['title' => '环境类型', 'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'example' => 'value123'],
],
],
],
],
],
],
],
],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取参数版本列表',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"ParameterVersion\\": [\\n {\\n \\"Id\\": 12345,\\n \\"Name\\": \\"workspace.para\\",\\n \\"Type\\": \\"PlainConstant\\",\\n \\"Scope\\": \\"Project\\",\\n \\"ProjectId\\": 1000,\\n \\"Version\\": 1,\\n \\"Description\\": \\"This is a test parameter.\\",\\n \\"CreateTime\\": 1640000000000,\\n \\"ModifyTime\\": 1640000000000,\\n \\"Owner\\": \\"123456789\\",\\n \\"CreateUser\\": \\"123456789\\",\\n \\"ModifyUser\\": \\"123456789\\",\\n \\"Properties\\": [\\n {\\n \\"EnvType\\": \\"Prod\\",\\n \\"Value\\": \\"value123\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'ListParameters' => [
'summary' => '查询参数列表。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '工作空间的ID。您可以通过ListProjects接口获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
],
[
'name' => 'Scope',
'in' => 'formData',
'schema' => [
'description' => '参数使用范围。默认Project，暂不可选择其他类型。',
'type' => 'string',
'required' => false,
'example' => 'Project',
'default' => 'Project',
'enum' => ['Project'],
],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '类型。'."\n"
.'- PlainConstant 常量（明文）'."\n"
.'- SecretConstant 常量（密文）'."\n"
.'- Variable 变量',
'type' => 'string',
'required' => false,
'example' => 'PlainConstant',
'enum' => ['PlainConstant', 'SecretConstant', 'Variable'],
],
],
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '参数ID列表。',
'type' => 'array',
'items' => ['description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
],
],
[
'name' => 'Names',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '参数名列表。',
'type' => 'array',
'items' => ['description' => '参数名。', 'type' => 'string', 'required' => false, 'example' => 'workspace.para'],
'required' => false,
],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '责任人的账号 ID。', 'type' => 'string', 'required' => false, 'example' => '123456789'],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => ['description' => '排序字段列表，支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
.'- ModifyTime (Desc/Asc)'."\n"
.'- CreateTime (Desc/Asc)'."\n"
.'- Name (Desc/Asc)', 'type' => 'string', 'required' => false, 'example' => 'ModifyTime Desc'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为20条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码数，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'PagingInfo' => [
'title' => '返回数据',
'description' => '返回数据',
'type' => 'object',
'properties' => [
'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['title' => '分页大小', 'description' => '每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['title' => '页码', 'description' => '页码数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Parameters' => [
'title' => '参数列表',
'description' => '参数列表',
'type' => 'array',
'items' => [
'title' => '参数信息',
'description' => '参数信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '参数ID', 'description' => '参数ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => 'workspace.para'],
'Type' => ['title' => '参数类型', 'description' => '类型。'."\n"
.'- PlainConstant 常量（明文）'."\n"
.'- SecretConstant 常量（密文）'."\n"
.'- Variable 变量', 'type' => 'string', 'example' => 'PlainConstant'],
'Scope' => ['title' => '参数范围', 'description' => '参数范围', 'type' => 'string', 'example' => 'Project'],
'ProjectId' => ['title' => '工作空间ID', 'description' => '工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'Version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Description' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'This is a test parameter.'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000'],
'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000'],
'Owner' => ['title' => '责任人', 'description' => '责任人', 'type' => 'string', 'example' => '123456789'],
'CreateUser' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'example' => '123456789'],
'ModifyUser' => ['title' => '修改人', 'description' => '修改人', 'type' => 'string', 'example' => '123456789'],
'Properties' => [
'title' => '参数值配置',
'description' => '参数值配置',
'type' => 'array',
'items' => [
'title' => '参数值配置项',
'description' => '参数值配置项',
'type' => 'object',
'properties' => [
'EnvType' => ['title' => '环境类型', 'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'example' => 'value123'],
],
],
],
],
],
],
],
],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取参数列表',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Parameters\\": [\\n {\\n \\"Id\\": 12345,\\n \\"Name\\": \\"workspace.para\\",\\n \\"Type\\": \\"PlainConstant\\",\\n \\"Scope\\": \\"Project\\",\\n \\"ProjectId\\": 1000,\\n \\"Version\\": 1,\\n \\"Description\\": \\"This is a test parameter.\\",\\n \\"CreateTime\\": 1640000000000,\\n \\"ModifyTime\\": 1640000000000,\\n \\"Owner\\": \\"123456789\\",\\n \\"CreateUser\\": \\"123456789\\",\\n \\"ModifyUser\\": \\"123456789\\",\\n \\"Properties\\": [\\n {\\n \\"EnvType\\": \\"Prod\\",\\n \\"Value\\": \\"value123\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'ListPartitions' => [
'summary' => '查询数据地图给定数据表的分区列表，当前支持maxcompute和hms（EMR集群）类型。',
'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' => '所属数据表ID，可参考ListTables接口返回结果，'."\n"
.'以及[元数据实体相关概念说明](~~2880092~~)。', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '分区名称', 'description' => '分区名称，模糊匹配，该参数仅对maxcompute类型有效', 'type' => 'string', 'required' => false, 'example' => 'ds=20250101'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为CreateTime',
'description' => '排序字段，默认为CreateTime，枚举值，当前支持'."\n"
."\n\n"
.'- CreateTime：创建时间，仅MaxCompute类型支持。'."\n"
.'- ModifyTime：修改时间，仅MaxCompute类型支持。'."\n"
.'- Name：名称，HMS类型使用的排序方式。'."\n"
.'- RecordCount：记录数，仅MaxCompute类型支持。'."\n"
.'- DataSize：存储量，仅MaxCompute类型支持。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CreateTime',
'default' => 'CreateTime',
'enum' => ['CreateTime', 'ModifyTime', 'Name', 'RecordCount', 'DataSize'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n"
."\n\n"
.'- Asc：升序。'."\n"
.'- Desc：降序。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID'."\n"
.'。', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功'."\n"
.'。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页结果',
'description' => '分页结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总记录数'."\n"
.'。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageNumber' => ['description' => '分页页码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PartitionList' => [
'title' => '数据表的分区列表',
'description' => '数据表的分区列表'."\n"
.'。',
'type' => 'array',
'items' => ['title' => '数据表的分区', 'description' => '数据表的分区'."\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' => '查询数据地图数据表的分区列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 目前只支持 maxcompute、hms （EMR集群）类型的表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListPartitions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListPendingApprovals' => [
'summary' => '获取当前用户作为审批人、待处理的权限申请单列表。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'DefSchema',
'in' => 'formData',
'schema' => ['description' => '根据资源类型筛选。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute'],
],
[
'name' => 'ResourceType',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据最小权限资源类型筛选。'."\n"
."\n"
.'注意：最小权限资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions). resources[*].isValidLeaf 为true 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'array',
'items' => ['description' => '资源类型', 'type' => 'string', 'required' => false, 'example' => 'table'],
'required' => true,
'example' => '["table", "column"]',
'maxItems' => 5,
],
],
[
'name' => 'Resource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据资源做精确/泛化筛选，资源的描述受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions) 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'DefSchema' => ['description' => '资源类型。'."\n"
."\n"
.'注意：系统支持申请的资源类型受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute'],
'DefVersion' => ['description' => '资源解析版本受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version约束。'."\n"
."\n"
.'[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'v1.0.0', 'default' => 'v1.0.0'],
'MetaData' => [
'description' => '资源元数据。'."\n"
."\n"
.'注意：元数据受 [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources 约束，有效的资源声明需要包含level 0到validLeaf层的全路径元数据声明。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "workspace": "449056",'."\n"
.' "project": "sync_destination"'."\n"
.' }', 'description' => '资源元数据'],
],
],
'required' => false,
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '申请时间开始（毫秒时间戳）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1771948800000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '申请时间结束（毫秒时间戳）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1779724799999'],
],
[
'name' => 'Grantee',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据授权主体筛选。 '."\n"
."\n"
.'注意：系统支持的授权主体类型受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'object',
'properties' => [
'PrincipalType' => ['description' => '授权主体类型', 'type' => 'string', 'required' => false, 'example' => 'RamRole'],
'PrincipalId' => ['description' => '授权主体ID', 'type' => 'string', 'required' => false, 'example' => 'ROLE_3133343434'],
],
'required' => false,
],
],
[
'name' => 'AccessTypes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据申请的权限筛选。'."\n"
."\n"
.'注意：不同层级资源支持权限的申请类型不同，统一受[ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf和accessTypeRestrictions和authMethodAccessTypes 约束。'."\n"
."\n"
.'附：[ResourceSchema国际站说明文档](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)',
'type' => 'array',
'items' => ['description' => '权限', 'type' => 'string', 'required' => false, 'example' => 'select'],
'required' => false,
],
],
[
'name' => 'NextToken',
'in' => 'formData',
'schema' => ['description' => '游标'."\n", 'type' => 'string', 'required' => false, 'example' => 'eyJpZCI6MTIzfQ=='],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页大小（默认10，最大200）'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '20', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'API请求响应错误码，调用出错时非空'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID，uuid生成'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
'Data' => [
'description' => '分页结果'."\n",
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页大小（默认10，最大200）'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'NextToken' => ['description' => '游标'."\n", 'type' => 'string', 'example' => 'eyJpZCI6MTIzfQ=='],
'HasMore' => ['description' => '是否有更多数据'."\n", 'type' => 'boolean', 'example' => 'false'],
'Data' => [
'description' => '分页结果中的数据列表'."\n",
'type' => 'array',
'items' => [
'description' => '审批流程与申请内容',
'type' => 'object',
'properties' => [
'ProcessInstanceId' => ['description' => '流程实例ID'."\n", 'type' => 'string', 'example' => '176906667488145'],
'DefSchema' => ['description' => '资源类型'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'Reason' => ['description' => '申请理由'."\n", 'type' => 'string', 'example' => '业务需要'],
'ApplicationTime' => ['description' => '申请发起时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '申请时间'],
'Status' => ['description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回', 'type' => 'string', 'example' => 'Deleted'],
'Contents' => [
'description' => '申请内容'."\n",
'type' => 'array',
'items' => [
'description' => '申请内容',
'type' => 'object',
'properties' => [
'Id' => ['description' => '申请内容唯一标识', 'type' => 'string', 'example' => '210001918826'],
'ProcessInstanceId' => ['description' => '**流程实例ID**', 'type' => 'string', 'example' => '176906667488145'],
'TenantId' => ['description' => '租户ID'."\n", 'type' => 'string', 'example' => '69973837489'],
'ResourceName' => ['description' => '最小权限资源类型'."\n", 'type' => 'string', 'example' => 'table'],
'DefSchema' => ['description' => '资源类型'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'AuthMethod' => ['description' => '授权方式'."\n", 'type' => 'string', 'example' => 'default'],
'Resource' => [
'description' => '资源声明'."\n",
'type' => 'object',
'properties' => [
'DefSchema' => ['description' => '资源解析依赖的ResourceSchema.name'."\n", 'type' => 'string', 'example' => 'MaxCompute'],
'DefVersion' => ['description' => '资源解析依赖的ResourceSchema.version'."\n", 'type' => 'string', 'example' => 'v1.0.0'],
'MetaData' => [
'description' => '资源元数据，数据内容受ResourceSchema约束'."\n",
'type' => 'object',
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "schema": "default",'."\n"
.' "threeTierModel": false,'."\n"
.' "project": "sync_dtestn",'."\n"
.' "workspace": "4477656",'."\n"
.' "table": "order",'."\n"
.' "tenant": "524257424864736"'."\n"
.' }', 'description' => '资源内容'],
],
],
],
'Grantee' => [
'description' => '授权主体描述'."\n",
'type' => 'object',
'properties' => [
'PrincipalType' => ['description' => '主体类型，枚举：'."\n"
."\n"
.'- RamRole'."\n"
.'- RamUser'."\n"
.'- DataworksTenantMember'."\n"
.'- DataworksTenantRole'."\n"
.'- DataworksProjectMember'."\n"
.'- DataworksProjectRole'."\n"
.'- DlfRole', 'type' => 'string', 'example' => 'RamUser'],
'PrincipalId' => ['description' => '主体ID。'."\n"
."\n"
.'注意：当principalType为不同类型时，对应不同语义：'."\n"
.'- RamUser：Dataworks UserId'."\n"
.'- RamRole："ROLE_"开头的Dataworks UserId'."\n"
.'- DataworksTenantMember：Dataworks UserId'."\n"
.'- DataworksTenantRole：Dataworks tenant roleCode'."\n"
.'- DataworksProjectRole：Dataworks workspace roleCode'."\n"
.'- DataworksProjectMember：Dataworks UserId'."\n"
.'- DlfRole：DlfNext role name', 'type' => 'string', 'example' => '213463068144525171'],
],
],
'AccessTypes' => [
'description' => '发起申请的资源操作权限'."\n",
'type' => 'array',
'items' => ['description' => '权限', 'type' => 'string', 'example' => 'select'],
],
'FinalAccessTypes' => [
'description' => '最终审批通过的资源操作权限'."\n",
'type' => 'array',
'items' => ['description' => 'select', 'type' => 'string', 'example' => 'select'],
],
'ExpirationTime' => ['description' => '权限截止日期，毫秒时间戳'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1782354014507'],
'Status' => ['description' => '审批状态筛选。枚举：'."\n"
."\n"
.'- WaitApproval 待审批'."\n"
.'- Confirmed 待授权'."\n"
.'- RejectApproval 审批拒绝'."\n"
.'- AuthorizeSucceed 授权成功'."\n"
.'- AuthorizeFailed 授权失败'."\n"
.'- Deleted 已删除'."\n"
.'- Canceled 已撤回', 'type' => 'string', 'example' => 'Deleted'],
'CreateTime' => ['description' => '创建时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-11 10:13:21'],
'UpdateTime' => ['description' => '更新时间'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-07-06 19:13:05'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询待审批的权限申请单',
'description' => '## 请求说明'."\n"
.'本接口用于查询当前登录用户作为审批人的所有待处理权限申请单。支持通过多种条件进行筛选，包括资源类型、时间范围、审批状态等，以便更精确地定位到特定的申请单。'."\n"
."\n"
.'- **ResourceType**：指定资源类型（如表），可以是多个值。'."\n"
.'- **Resource**：提供具体的资源检索条件，比如所属项目、数据库或表名。'."\n"
.'- **StartTime 和 EndTime**：定义了申请发起的时间范围。'."\n"
.'- **Statuses**：允许按审批状态过滤结果，例如只查看待审批的状态。'."\n"
.'- **Grantee**：根据授权对象的信息来过滤申请单。'."\n"
.'- **AccessTypes**：基于请求的具体权限类型（如读取、更新）来筛选。'."\n"
.'- **PageSize 和 NextToken**：用于分页控制，每次请求返回的数据量以及获取下一页数据所需的游标。'."\n"
."\n"
.'注意事项：'."\n"
.'- 如果不提供任何筛选条件，则默认返回所有符合条件的记录。'."\n"
.'- `NextToken` 参数在首次调用时可为空或省略；后续页面请求需使用上一次响应中提供的 `NextToken` 值。'."\n"
."\n\n"
.'- `PageSize` 的默认值为 10，最大值为 200。如果设置的值超过最大限制，则按最大值处理。'."\n"
.'- 当没有更多数据可返回时，`HasMore` 字段将被设置为 `false`，并且 `NextToken` 将为空或不存在。'."\n"
."\n"
.'## 响应说明'."\n"
.'成功调用该 API 后，响应体中包含分页结果及每条申请单的详细信息，如申请时间、资源描述、授权对象、请求权限等。此外，还提供了审批流程的状态和其他相关元数据。'."\n"
."\n"
.'- **Data**：分页结果集，包括每页大小 (`PageSize`)、游标 (`NextToken`) 和是否还有更多数据 (`HasMore`) 等信息。'."\n"
.'- **ApplicationQueryResponse**：每个申请单的具体内容，包括申请理由、发起时间、状态以及详细的申请内容列表。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"NextToken\\": \\"eyJpZCI6MTIzfQ==\\",\\n \\"HasMore\\": false,\\n \\"Data\\": [\\n {\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 0,\\n \\"Status\\": \\"Deleted\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"210001918826\\",\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"AuthMethod\\": \\"default\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"schema\\\\\\": \\\\\\"default\\\\\\",\\\\n \\\\\\"threeTierModel\\\\\\": false,\\\\n \\\\\\"project\\\\\\": \\\\\\"sync_dtestn\\\\\\",\\\\n \\\\\\"workspace\\\\\\": \\\\\\"4477656\\\\\\",\\\\n \\\\\\"table\\\\\\": \\\\\\"order\\\\\\",\\\\n \\\\\\"tenant\\\\\\": \\\\\\"524257424864736\\\\\\"\\\\n }\\"\\n }\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalId\\": \\"213463068144525171\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1782354014507,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListPipelineRunItems' => [
'summary' => '通过发布流程的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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'PipelineRunId',
'in' => 'query',
'schema' => ['description' => '工作流任务ID，如何获取工作流任务ID，'."\n"
.'请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => ' '."\n"
.'097c73fe-ed6e-4fb1-b109-a5d59e46cd58'."\n"],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '请求的数据页数，'."\n"
.'用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，'."\n"
.'默认为10条，最大100条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次调用的唯一ID。'."\n"
.'出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PipelineRunItems' => [
'description' => '发布物列表。',
'type' => 'array',
'items' => [
'description' => '发布物详情。',
'type' => 'object',
'properties' => [
'Version' => ['title' => '项目Id', 'description' => '发布物版本。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1', 'pattern' => '', 'default' => ''],
'Name' => ['description' => '发布物名称。', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['title' => '发布包创建时间戳', 'description' => '发布物创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1724984066000'],
'ModifyTime' => ['title' => '修改时间', 'description' => '发布物修改时间。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1724984066000', 'pattern' => '', 'default' => ''],
'Status' => [
'title' => '发布流程状态',
'description' => '发布物状态'."\n"
."\n"
.'- Init 初始化'."\n"
.'- Running 运行中'."\n"
.'- Success 成功'."\n"
.'- Fail 失败'."\n"
.'- Termination 终止',
'type' => 'string',
'deprecated' => false,
'example' => 'Running',
'pattern' => '',
'default' => '',
'enum' => ['Init', 'Running', 'Success', 'Fail', 'Termination'],
],
'Message' => ['title' => '创建人', 'description' => '发布失败的错误信息。', 'type' => 'string', 'deprecated' => false, 'example' => 'Error Message', 'pattern' => '', 'default' => ''],
'Type' => ['description' => '发布物类型'."\n"
."\n"
.'- Node 节点'."\n"
.'- WorkflowDefinition 工作流定义'."\n"
.'- Resource 资源'."\n"
.'- Function 函数', 'type' => 'string', 'example' => 'Node'],
'Spec' => ['description' => '描述这个发布物的 FlowSpec 信息，'."\n"
.'具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', 'type' => 'string', 'example' => '{ "version": "1.1.0", "kind": "Node", "spec": { "nodes": [ { "recurrence": "Normal", "id": "860438872620113XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "datasource": { "name": "odps_test", "type": "odps" }, "script": { "language": "odps-sql", "path": "XX/OpenAPI_Test/ODPS_SQL_Test", "runtime": { "command": "ODPS_SQL", "commandTypeId": 10 }, "content": "select now();", "id": "853573334108680XXXX" }, "trigger": { "type": "Scheduler", "id": "543680677872062XXXX", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "623731286945488XXXX", "resourceGroupId": "7201XXXX" }, "name": "ODPS_SQL_Test", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "XXXXX@test.XXX.com", "projectId": "307XXX" }, "inputs": { "nodeOutputs": [ { "data": "lwttest_standard_root", "artifactType": "NodeOutput" } ] }, "outputs": { "nodeOutputs": [ { "data": "860438872620113XXXX", "artifactType": "NodeOutput", "refTableName": "ODPS_SQL_Test", "isDefault": true } ] } } ], "flow": [ { "nodeId": "860438872620113XXXX", "depends": [ { "type": "Normal", "output": "lwttest_standard_root" } ] } ] }, "metadata": { "uuid": "860438872620113XXXX" } }'],
'Id' => ['description' => '发布物唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', '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' => '获取发布内容',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListPipelineRuns' => [
'summary' => '分页获取发布流程列表，也可以使用筛选条件对发布流程进行筛选。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => '筛选条件：发布流程的创建者', 'type' => 'string', 'required' => false, 'example' => '110755000425****'."\n"],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '筛选条件：发布流程的当前状态'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Init 初始化'."\n"
.'- Running 运行中'."\n"
.'- Success 运行成功'."\n"
.'- Fail 运行失败'."\n"
.'- Termination 被终止'."\n"
.'- Cancel 被取消', 'type' => 'string', 'required' => false, 'example' => 'Running'],
],
[
'name' => 'ObjectId',
'in' => 'query',
'schema' => ['title' => '发布物的ID', 'description' => '发布物的ID', 'type' => 'string', 'required' => false, 'example' => '860438872620113XXXX'."\n"],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'."\n"],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2524'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '查询分页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PipelineRuns' => [
'description' => '发布流程信息列表。',
'type' => 'array',
'items' => [
'description' => '发布流程列表元素',
'type' => 'object',
'properties' => [
'Id' => ['title' => '发布流程Id', 'description' => '发布流程Id', 'type' => 'string', 'deprecated' => false, 'example' => '097c73fe-ed6e-4fb1-b109-a5d59e46cd58', 'pattern' => '', 'default' => ''],
'ProjectId' => ['title' => '项目Id', 'description' => '项目Id', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '70199', 'pattern' => '', 'default' => ''],
'CreateTime' => ['title' => '发布包创建时间戳', 'description' => '发布包创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1702736654000'],
'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1702736654000', 'pattern' => '', 'default' => ''],
'Creator' => ['title' => '创建人', 'description' => '创建人', 'type' => 'string', 'deprecated' => false, 'example' => '110755000425XXXX', 'pattern' => '', 'default' => ''],
'Status' => [
'title' => '发布流程状态',
'description' => '发布流程状态'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Init 初始化'."\n"
.'- Running 运行中'."\n"
.'- Success 运行成功'."\n"
.'- Fail 运行失败'."\n"
.'- Termination 被终止'."\n"
.'- Cancel 被取消',
'type' => 'string',
'deprecated' => false,
'example' => 'Running',
'pattern' => '',
'default' => '',
'enum' => ['Init', 'Running', 'Success', 'Fail', 'Termination', 'Cancel'],
],
'Message' => ['description' => '发布阶段发生错误时的错误信息', 'type' => 'string', 'example' => 'Error message'],
'Stages' => [
'title' => '步骤详情',
'description' => '发布阶段列表',
'type' => 'array',
'items' => [
'title' => 'stage的元素',
'description' => '发布阶段列表元素',
'type' => 'object',
'properties' => [
'Code' => ['title' => '阶段代号', 'description' => '发布阶段代号', 'type' => 'string', 'deprecated' => false, 'example' => 'DEV_CHECK', 'pattern' => '', 'default' => ''],
'Step' => ['title' => '步骤', 'description' => '发布阶段步骤编号', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'example' => '1', 'pattern' => '', 'default' => ''],
'Type' => ['title' => '阶段类型', 'description' => '发布阶段类型，是该发布阶段操作类型的一个分类。'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Deploy 发布操作'."\n"
.'- Check 检查操作'."\n"
.'- Offline 下线操作'."\n"
.'- Build 构建操作'."\n"
.'- Delete 删除操作', 'type' => 'string', 'deprecated' => false, 'example' => 'Check', 'pattern' => '', 'default' => ''],
'Name' => ['title' => '阶段名称', 'description' => '阶段名称', 'type' => 'string', 'deprecated' => false, 'example' => 'Check before going online to development'."\n", 'pattern' => '', 'default' => ''],
'Description' => ['title' => '阶段描述', 'description' => '阶段描述', 'type' => 'string', 'deprecated' => false, 'example' => 'Check before going online to development'."\n", 'pattern' => '', 'default' => ''],
'Message' => ['title' => '阶段信息', 'description' => '发布阶段发生错误时的错误信息', 'type' => 'string', 'deprecated' => false, 'example' => 'Error message'."\n", 'pattern' => '', 'default' => ''],
'Status' => ['title' => '阶段状态', 'description' => '发布阶段状态'."\n"
."\n"
.'可选值'."\n"
."\n\n"
.'- Init 初始化'."\n"
.'- Running 运行中'."\n"
.'- Success 运行成功'."\n"
.'- Fail 运行失败'."\n"
.'- Termination 被终止'."\n"
.'- Cancel 被取消', 'type' => 'string', 'deprecated' => false, 'example' => 'Running', 'pattern' => '', 'default' => ''],
'Detail' => [
'title' => '阶段详细信息',
'description' => '发布阶段的其他补充信息',
'type' => 'object',
'deprecated' => false,
'additionalProperties' => ['type' => 'any', 'description' => '补充信息', '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' => '发布流程的描述信息', 'description' => '发布流程的描述信息', 'type' => 'string', 'example' => 'Release process description'],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PipelineRuns\\": [\\n {\\n \\"Id\\": \\"097c73fe-ed6e-4fb1-b109-a5d59e46cd58\\",\\n \\"ProjectId\\": 70199,\\n \\"CreateTime\\": 1702736654000,\\n \\"ModifyTime\\": 1702736654000,\\n \\"Creator\\": \\"110755000425XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Check before going online to development\\\\n\\",\\n \\"Description\\": \\"Check before going online to development\\\\n\\",\\n \\"Message\\": \\"Error message\\\\n\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"package check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"downstream dependency check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"offline process check\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"Release process description\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取发布流程列表',
'description' => '>低版本的SDK中可能无该接口，此时请使用ListDeployments接口，参数与该文档一致。>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListProcessDefinitions' => [
'summary' => '查询指定类型的审批流程定义列表',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244496',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => '流程定义类型，综合枚举：'."\n"
."\n"
.'- MaxCompute'."\n"
.'- DataService'."\n"
.'- Extension'."\n"
.'- Hologres'."\n"
.'- Emr'."\n"
.'- DataAssetGovernance'."\n"
.'- Lindorm'."\n"
.'- DlfNext'."\n"
.'- DlfV1'."\n"
.'- StarRocks', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'default' => 'MaxComputeTable'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '- **API请求ID**'."\n"
.'- **API请求错误信息**：调用出错时非空'."\n"
.'- **API请求响应错误码**：调用出错时非空'."\n"
.'- **流程定义列表**：参考 ProcessDefinition 定义'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
'PagingInfo' => [
'description' => '流程定义列表，参考 ProcessDefinition 定义'."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'ProcessDefinitions' => [
'description' => '流程定义列表，参考 ProcessDefinition 定义'."\n",
'type' => 'array',
'items' => [
'description' => '流程定义概要',
'type' => 'object',
'properties' => [
'Id' => ['description' => '流程定义 ID', 'type' => 'string', 'example' => '10354346'],
'Name' => ['description' => '**流程定义名称**'."\n", 'type' => 'string', 'example' => 'MaxCompute 表审批'],
'Description' => ['description' => '**流程定义描述**'."\n", 'type' => 'string', 'example' => 'lwt_ide_simple 项目 MaxCompute 表审批策略'],
'Type' => ['description' => '流程定义类型，枚举：'."\n"
."\n"
.'- MaxCompute'."\n"
.'- DataService'."\n"
.'- Extension'."\n"
.'- Hologres'."\n"
.'- DlfV1 【不支持自定义新建】'."\n"
.'- Emr 【不支持自定义新建】'."\n"
.'- DataAssetGovernance【不支持自定义新建】'."\n"
.'- Lindorm【不支持自定义新建】'."\n"
.'- StarRocks【不支持自定义新建】'."\n"
.'- DlfNext【不支持自定义新建】'."\n"
.'- DataWorks【不支持自定义新建】', 'type' => 'string', 'example' => 'MaxCompute'],
'SubType' => ['description' => '子类型：'."\n"
.'- Table'."\n"
.'- Column'."\n"
.'- Database'."\n"
.'- Schema'."\n"
.'- Default', 'type' => 'string', 'example' => 'Table'],
'IsSystem' => ['description' => '是否为系统默认策略，系统策略只能更新通知服务', 'type' => 'boolean', 'example' => 'false'],
'Enabled' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'true'],
'Priority' => ['description' => '优先级，数值越小优先级越高'."\n", 'type' => 'string', 'example' => '1'],
'Scopes' => [
'description' => '规则生效阶段：'."\n"
.'- `Deployment` 用于判定"提交申请时是否匹配该审批策略'."\n"
.'- `Running` 用于审批流程执行判定是否免审批【仅支持MaxCompute类型】',
'type' => 'array',
'items' => ['description' => '规则生效阶段', 'type' => 'string', 'example' => 'Deployment'],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '审批流程定义列表查询',
'description' => '## 请求说明'."\n"
.'- 该API用于根据给定的策略类型（PolicyType）查询审批流程定义列表。'."\n"
.'- 支持分页查询，可以通过设置`PageSize`和`PageNumber`参数来控制每页显示的数量及当前页码。'."\n"
.'- `NextToken`和`MaxResults`参数可用于处理大量数据时的分页请求。'."\n"
.'- 返回结果中包含总记录数（TotalCount）、每页大小（PageSize）、当前页码（PageNumber）以及具体的审批流程定义列表信息。'."\n"
.'- 每个审批流程定义包括ID、是否启用状态（Enabled）、优先级（Priority）等关键属性。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"ProcessDefinitions\\": [\\n {\\n \\"Id\\": \\"10354346\\",\\n \\"Name\\": \\"MaxCompute 表审批\\",\\n \\"Description\\": \\"lwt_ide_simple 项目 MaxCompute 表审批策略\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"SubType\\": \\"Table\\",\\n \\"IsSystem\\": false,\\n \\"Enabled\\": true,\\n \\"Priority\\": \\"1\\",\\n \\"Scopes\\": [\\n \\"Deployment\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListProjectMembers' => [
'summary' => '分页查询工作空间成员详情。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '62136'],
],
[
'name' => 'UserIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'DataWorks账号 ID 列表。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看需要操作的账号 ID。',
'type' => 'array',
'items' => ['description' => 'DataWorks账号 ID 。', 'type' => 'string', 'required' => false, 'example' => '123422344899'],
'required' => false,
],
],
[
'name' => 'RoleCodes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作空间角色 Code 列表。 您可以调用 [ListProjectRoles](~~2853930~~) 获取角色的 Code。',
'type' => 'array',
'items' => ['description' => '工作空间角色 Code 。', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest'],
'required' => false,
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为 10 条，最大 100 条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '9FBBBB1F-DD5E-5D8E-8F50-37F77460F056'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'ProjectMembers' => [
'description' => '工作空间成员列表。',
'type' => 'array',
'items' => [
'description' => '工作空间成员详情。',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => 'DataWorks工作空间的ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '62136'],
'UserId' => ['description' => 'DataWorks账号 ID。', 'type' => 'string', 'example' => '123422344899'],
'Status' => [
'description' => '工作空间成员状态。'."\n"
."\n"
.'- Normal 正常。'."\n"
."\n"
.'- Forbidden 已禁用。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'Roles' => [
'description' => '工作空间成员已经授予的空间角色列表。',
'type' => 'array',
'items' => [
'description' => '已授予的空间角色详情。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '工作空间的角色 Code。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'role_project_guest',
],
'Name' => ['description' => '工作空间的角色 Name。', 'type' => 'string', 'example' => 'Visitors'],
'Type' => ['description' => '工作空间的角色类型。'."\n"
."\n"
.'- UserCustom 用户自定义角色'."\n"
.'- System 系统角色', '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' => '查询工作空间成员列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListProjectMembers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListProjectRoles' => [
'summary' => '分页查询工作空间角色详情。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244505',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21229'],
],
[
'name' => 'Codes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作空间角色 Code 列表',
'type' => 'array',
'items' => [
'description' => '工作空间的角色 Code。'."\n"
.'- role_project_admin：空间管理员'."\n"
.'- role_project_dev：开发'."\n"
.'- role_project_dg_admin：数据治理管理员'."\n"
.'- role_project_guest：访客'."\n"
.'- role_project_security：安全管理员'."\n"
.'- role_project_deploy：部署'."\n"
.'- role_project_owner：工作空间所有者'."\n"
.'- role_project_data_analyst：数据分析师'."\n"
.'- role_project_pe：运维'."\n"
.'- role_project_erd：模型设计师',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'role_project_guest',
],
'required' => false,
],
],
[
'name' => 'Names',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作空间的角色 Name 列表',
'type' => 'array',
'items' => ['description' => '工作空间的角色 Name。', 'type' => 'string', 'required' => false, 'example' => 'Visitors'],
'required' => false,
],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '工作空间的角色类型。'."\n"
.'- UserCustom：用户自定义角色'."\n"
.'- System：系统角色',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'System',
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为 10 条，最大 100 条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '61649187-0BCF-5E75-8D4B-64FDBEBBB447'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页显示的条数', 'type' => 'string', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'string', 'example' => '1'],
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'string', 'example' => '42'],
'ProjectRoles' => [
'description' => '工作空间角色列表',
'type' => 'array',
'items' => [
'description' => '工作空间角色详细信息',
'type' => 'object',
'properties' => [
'ProjectId' => ['description' => 'DataWorks工作空间的ID。'."\n"
."\n"
.'特殊说明：系统默认的工作空间角色，ProjectId返回固定值-1。', 'type' => 'integer', 'format' => 'int64', 'example' => '21229'],
'Code' => ['description' => '工作空间的角色 Code。', 'type' => 'string', 'example' => 'role_project_guest'."\n"],
'Name' => ['description' => '工作空间的角色 Name。', 'type' => 'string', 'example' => 'Visitors'],
'Type' => ['description' => '工作空间的角色类型。', 'type' => 'string', 'example' => 'System'],
'ModulePermissions' => [
'title' => '角色拥有的Dataworks产品模块权限列表',
'type' => 'array',
'items' => [
'title' => '角色拥有的Dataworks产品模块权限',
'type' => 'object',
'properties' => [
'ModuleId' => ['title' => 'Dataworks模块Id', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ModuleName' => ['title' => 'Dataworks模块名称', 'type' => 'string', 'example' => 'HoloStudio'],
'PermissionType' => ['title' => '权限类型。', 'type' => 'string', 'example' => 'Read'],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作空间角色详情列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListProjectRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61649187-0BCF-5E75-8D4B-64FDBEBBB447\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalCount\\": \\"42\\",\\n \\"ProjectRoles\\": [\\n {\\n \\"ProjectId\\": 21229,\\n \\"Code\\": \\"role_project_guest\\\\n\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleId\\": 2,\\n \\"ModuleName\\": \\"HoloStudio\\",\\n \\"PermissionType\\": \\"Read\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListProjects' => [
'summary' => '该接口用于查询用户所在租户下的DataWorks工作空间列表。',
'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' => 'DataWorks工作空间ID列表。'."\n"
."\n"
.'该参数用来查询符合工作空间 ID列表的空间详情。',
'type' => 'array',
'items' => ['description' => '工作空间ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
'required' => false,
],
],
[
'name' => 'Names',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'DataWorks工作空间名称列表。'."\n"
."\n"
.'该参数用来查询符合工作空间 Name列表的空间详情。',
'type' => 'array',
'items' => ['description' => '工作空间名称。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 Name。', 'type' => 'string', 'required' => false, 'example' => 'sora_finance'],
'required' => false,
],
],
[
'name' => 'AliyunResourceGroupId',
'in' => 'formData',
'schema' => ['description' => '工作空间所属阿里云资源组ID。您可以登录[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups)，进入资源组列表页面获取 ID。'."\n"
."\n"
.'该参数用来查询归属该资源组的工作空间详情。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzbn****'],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '空间状态：'."\n"
."\n"
.'- Available：工作空间运行正常'."\n"
.'- Initializing：初始化工作空间'."\n"
.'- InitFailed：工作空间初始化失败'."\n"
.'- Forbidden：手动禁用工作空间'."\n"
.'- Deleting：正在删除工作空间'."\n"
.'- DeleteFailed：工作空间删除失败'."\n"
.'- Frozen：工作空间欠费冻结'."\n"
.'- Updating：更新工作空间中'."\n"
.'- UpdateFailed：更新工作空间失败'."\n"
."\n"
.'该参数用于查询符合该状态的工作空间详情。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Available',
],
],
[
'name' => 'DevEnvironmentEnabled',
'in' => 'formData',
'schema' => ['description' => '是否启用开发环境：'."\n"
."\n"
.'- true 工作空间启用开发环境，支持开发与生产环境隔离'."\n"
."\n"
.'- false 仅使用生产环境'."\n"
."\n"
.'该参数用于查询符合“启用/未启用开发环境”条件的工作空间详情。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DevRoleDisabled',
'in' => 'formData',
'schema' => ['description' => '是否禁用开发角色：'."\n"
."\n"
.'- false，开启开发角色（默认）'."\n"
."\n"
.'- true，禁用开发角色'."\n"
."\n"
.'该参数用于查询符合“开启/禁用开发角色”条件的工作空间详情。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'PaiTaskEnabled',
'in' => 'formData',
'schema' => ['description' => '是否启用PAI任务调度：'."\n"
."\n"
.'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n"
."\n"
.'- false 禁用PAI任务调度'."\n"
."\n"
.'该参数用于查询符合“开启/未开启PAI任务调用”条件的工作空间详情。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AliyunResourceTags',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '标签列表。'."\n"
."\n"
.'该参数用于查询拥有任意标签键值信息的工作空间详情。',
'type' => 'array',
'items' => [
'description' => '标签详情。 您可以登录 [资源管理控制台](https://resourcemanager.console.aliyun.com/tags)，进入标签列表页面获取 Key、Value。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'batch'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'blue'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页显示的条数，默认为 10 条，最大 100 条。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '6D24AD9A-652F-59E2-AC1F-05029300F8A4'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Projects' => [
'description' => '工作空间列表。',
'type' => 'array',
'items' => [
'description' => '工作空间详细信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'Name' => ['description' => '工作空间名称。', 'type' => 'string', 'example' => 'sora_finance'],
'DisplayName' => ['description' => '工作空间展示名称。', 'type' => 'string', 'example' => 'Sora financial analysis'."\n"],
'Description' => ['description' => '工作空间描述。', 'type' => 'string', 'example' => 'Financial analysis group project data development'],
'Owner' => ['description' => '工作空间拥有者UserId，即阿里云账号ID。', 'type' => 'string', 'example' => '123532153125'],
'AliyunResourceGroupId' => ['description' => '工作空间所属阿里云资源组ID。', 'type' => 'string', 'example' => 'rg-acfmzbn7pti3zfa'],
'Status' => ['description' => '空间状态：'."\n"
."\n"
.'- Available：工作空间运行正常'."\n"
.'- Initializing：初始化工作空间'."\n"
.'- InitFailed：工作空间初始化失败'."\n"
.'- Forbidden：手动禁用工作空间'."\n"
.'- Deleting：正在删除工作空间'."\n"
.'- DeleteFailed：工作空间删除失败'."\n"
.'- Frozen：工作空间欠费冻结'."\n"
.'- Updating：更新工作空间中'."\n"
.'- UpdateFailed：更新工作空间失败', 'type' => 'string', 'example' => 'Available'],
'PaiTaskEnabled' => ['description' => '是否启用PAI任务调度：'."\n"
."\n"
.'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n"
."\n"
.'- false 禁用PAI任务调度。', 'type' => 'boolean', 'example' => 'true'],
'DevEnvironmentEnabled' => ['description' => '是否启用开发环境：'."\n"
."\n"
.'- true 工作空间启用开发环境，支持开发与生产环境隔离。'."\n"
."\n"
.'- false 仅使用生产环境。', 'type' => 'boolean', 'example' => 'true'],
'DevRoleDisabled' => ['description' => '是否禁用开发角色：'."\n"
."\n"
.'- false，开启开发角色'."\n"
."\n"
.'- true，禁用开发角色', 'type' => 'boolean', 'example' => 'false'],
'AliyunResourceTags' => [
'description' => '标签组。',
'type' => 'array',
'items' => [
'description' => '标签详情。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'batch'],
'Value' => ['description' => '标签值。', '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' => '获取工作空间详情列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListProjects',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListResourceGroupAssociateProjects' => [
'summary' => '获取资源组绑定工作空间列表。',
'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' => '通用资源组唯一标识', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'ProjectIdList' => [
'title' => '项目空间ID列表',
'description' => '项目空间ID列表',
'type' => 'array',
'items' => ['title' => '项目空间ID', 'description' => '项目空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n"],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取资源组绑定工作空间列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**'."\n"
.'3. 本接口仅返回当前调用者具备访问权限的工作空间，未授权的工作空间不会出现在返回结果中。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ProjectIdList\\": [\\n 123\\n ],\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]',
],
'ListResourceGroupMetricData' => [
'summary' => '查询资源组指标数据。',
'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' => '通用资源组唯一标识。', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
[
'name' => 'MetricName',
'in' => 'formData',
'schema' => [
'title' => '指标名称',
'description' => '指标名称，可选指标有：'."\n"
."\n"
.'- CUSpec：资源组最大CU容量，单位，CU。'."\n"
.'- CUUsage：资源组CU使用量，单位：CU。'."\n"
.'- CUUtilization：资源组CU使用率，单位：%。'."\n"
.'- SlotSpec：资源组调度最大并发数，单位，slot。'."\n"
.'- SlotUsage：资源组调度已使用并发数，单位，slot。'."\n"
.'- SchedulerCUMaxSpec：数据计算用途最大CU配额，单位，CU。'."\n"
.'- SchedulerCUUsage：数据计算用途CU使用量，单位，CU。'."\n"
.'- SchedulerCUMinSpec：数据计算用途最低保障CU，单位，CU。'."\n"
.'- DataIntegrationCUMaxSpec：数据集成用途最大CU配额，单位，CU。'."\n"
.'- DataIntegrationCUUsage：数据集成用途CU使用量，单位，CU。'."\n"
.'- DataIntegrationCUMinSpec：数据集成用途最低保障CU，单位，CU。'."\n"
.'- DataServiceCUMaxSpec：数据服务用途最大CU配额，单位，CU。'."\n"
.'- DataServiceCUUsage：数据服务用途CU使用量，单位，CU。'."\n"
.'- DataServiceCUMinSpec：数据服务用途最低保障CU，单位，CU。'."\n"
.'- ServerIdeCUMaxSpec：个人开发环境用途最大CU配额，单位，CU。'."\n"
.'- ServerIdeCUUsage：个人开发环境用途CU使用量，单位，CU。'."\n"
.'- ServerIdeCUMinSpec：个人开发环境用途最低保障CU，单位，CU。',
'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' => '监控数据的统计周期。'."\n"
."\n"
.'取值：60的倍数。'."\n"
."\n"
.'单位：秒。'."\n"
."\n"
.'默认值：60。', 'type' => 'string', 'required' => false, 'example' => '60'],
],
[
'name' => 'BeginTime',
'in' => 'formData',
'schema' => ['title' => '开始时间。支持的格式：'."\n"
.'Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n"
.'BeginTime 和 EndTime 之间的间隔小于等于 31 天。', 'description' => '开始时间。'."\n"
."\n"
.'支持的格式：Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n"
."\n"
.'BeginTime 和 EndTime 之间的间隔小于等于 31 天。'."\n"
."\n"
.'默认值：当前时间 - 2小时，以毫秒级 Unix 时间戳格式表示。', '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' => '结束时间。'."\n"
."\n"
.'支持的格式：Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n"
."\n"
.'BeginTime 和 EndTime 之间的间隔小于等于 31 天。'."\n"
."\n"
.'默认值：当前时间，以毫秒级 Unix 时间戳格式表示。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '1750176000000'],
],
[
'name' => 'NextToken',
'in' => 'formData',
'schema' => ['title' => '分页游标标识。'."\n"
.'说明：如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。', 'description' => '分页游标标识。'."\n"
."\n"
.'> 如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。', 'type' => 'string', 'required' => false, 'example' => 'FFqBJBxE8I0PE0IUO6K69k7m2FfyWNNc2qQ9ReUkazhz9VA7dWZKlxBcjUwOV0imSM'],
],
[
'name' => 'Length',
'in' => 'formData',
'schema' => ['title' => '每页显示的记录条数，用于分页查询。'."\n"
.'说明：单次请求 Length 的最大值为 1440。', 'description' => '每页显示的记录条数，用于分页查询。'."\n"
.'> 单次请求 Length 的最大值为 1440。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1440', 'minimum' => '0', 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'MetricData' => [
'title' => '监控指标数据',
'description' => '监控指标数据。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '资源组唯一标识', 'description' => '资源组唯一标识。', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'."\n"],
'MetricName' => ['title' => '指标名称', 'description' => '指标名称，可选指标有：'."\n"
."\n"
.'- CUSpec：资源组最大CU容量，单位，CU。'."\n"
.'- CUUsage：资源组CU使用量，单位：CU。'."\n"
.'- CUUtilization：资源组CU使用率，单位：%。'."\n"
.'- SlotSpec：资源组调度最大并发数，单位，slot。'."\n"
.'- SlotUsage：资源组调度已使用并发数，单位，slot。'."\n"
.'- SchedulerCUMaxSpec：数据计算用途最大CU配额，单位，CU。'."\n"
.'- SchedulerCUUsage：数据计算用途CU使用量，单位，CU。'."\n"
.'- SchedulerCUMinSpec：数据计算用途最低保障CU，单位，CU。'."\n"
.'- DataIntegrationCUMaxSpec：数据集成用途最大CU配额，单位，CU。'."\n"
.'- DataIntegrationCUUsage：数据集成用途CU使用量，单位，CU。'."\n"
.'- DataIntegrationCUMinSpec：数据集成用途最低保障CU，单位，CU。'."\n"
.'- DataServiceCUMaxSpec：数据服务用途最大CU配额，单位，CU。'."\n"
.'- DataServiceCUUsage：数据服务用途CU使用量，单位，CU。'."\n"
.'- DataServiceCUMinSpec：数据服务用途最低保障CU，单位，CU。'."\n"
.'- ServerIdeCUMaxSpec：个人开发环境用途最大CU配额，单位，CU。'."\n"
.'- ServerIdeCUUsage：个人开发环境用途CU使用量，单位，CU。'."\n"
.'- ServerIdeCUMinSpec：个人开发环境用途最低保障CU，单位，CU。', 'type' => 'string', 'example' => 'CUSpec'],
'NextToken' => ['title' => '分页游标标识', 'description' => '分页游标标识。', 'type' => 'string', 'example' => 'tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl'],
'Metrics' => [
'title' => '指标数据列表',
'description' => '指标数据列表。',
'type' => 'array',
'items' => [
'title' => '指标数据',
'description' => '指标数据。',
'type' => 'object',
'properties' => [
'Value' => ['title' => '指标数据值', 'description' => '指标数据值。', 'type' => 'number', 'format' => 'double', 'example' => '1.0'],
'Timestamp' => ['title' => '时间戳', 'description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1761184929633'],
],
],
],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n"],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询资源组指标数据',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**'."\n"
.'3. 该接口只适用于Serverless资源组。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListResourceGroupMetricData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"MetricData\\": {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\\\n\\",\\n \\"MetricName\\": \\"CUSpec\\",\\n \\"NextToken\\": \\"tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 1,\\n \\"Timestamp\\": 1761184929633\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]',
],
'ListResourceGroups' => [
'summary' => '获取资源组列表。',
'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' => '资源组名称，用于模糊查询', 'type' => 'string', 'required' => false, 'example' => 'Resource'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['title' => '所属工作空间ID', 'description' => '所属工作空间ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
],
[
'name' => 'Statuses',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '查询的资源组状态列表',
'description' => '查询的资源组状态列表',
'type' => 'array',
'items' => [
'title' => '查询的资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时；Freezed: 冻结；Starting: 启动中。',
'description' => '查询的资源组状态：'."\n"
."\n"
.'- Normal: 正常 (运行中/服务中)；'."\n"
.'- Stop: 冻结 (已到期)；'."\n"
.'- Deleted: 删除 (已释放/已销毁)；'."\n"
.'- Creating: 创建中；'."\n"
.'- CreateFailed: 创建失败；'."\n"
.'- Updating: 更新中 (扩容中/缩容中/变配中)；'."\n"
.'- UpdateFailed: 更新失败 (扩容失败/升级失败)；'."\n"
.'- Deleting: 删除中 (释放中/销毁中)；'."\n"
.'- DeleteFailed: 删除失败 (释放失败/销毁失败)；'."\n"
.'- Timeout: 操作超时；'."\n"
.'- Freezed：冻结；'."\n"
.'- Starting：启动中。',
'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' => '查询的资源组类型列表，**为空默认查询通用资源组**',
'type' => 'array',
'items' => [
'title' => '查询的资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组',
'description' => '资源组类型：'."\n"
."\n"
.'- CommonV2：新版通用资源组；'."\n"
.'- ExclusiveDataIntegration：独享数据集成资源组；'."\n"
.'- ExclusiveScheduler：独享调度资源组；'."\n"
.'- ExclusiveDataService：独享数据服务资源组',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CommonV2',
'enum' => ['CommonV2', 'ExclusiveScheduler', 'ExclusiveDataIntegration', 'ExclusiveDataService'],
],
'required' => false,
],
],
[
'name' => 'PaymentType',
'in' => 'query',
'schema' => [
'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ',
'description' => '资源组的付费类型。'."\n"
.'- PrePaid：包年包月。'."\n"
.'- PostPaid：按量付费 。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'PrePaid',
'enum' => ['PrePaid', 'PostPaid'],
],
],
[
'name' => 'AliyunResourceGroupId',
'in' => 'query',
'schema' => ['title' => '阿里云资源组ID', 'description' => '阿里云资源组ID', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2kqofrgXXXXX'],
],
[
'name' => 'AliyunResourceTags',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'json',
'schema' => [
'title' => '阿里云标签列表',
'description' => '阿里云标签列表',
'type' => 'array',
'items' => [
'title' => '阿里云标签',
'description' => '阿里云标签',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签Key', 'description' => '标签Key', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['title' => '标签Value', 'description' => '标签Value', 'type' => 'string', 'required' => false, 'example' => 'value'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '100'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码', 'description' => '分页页码', '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' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
."\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"
."\n"
.'默认值为CreateTime Asc', 'type' => 'string', 'required' => false, 'example' => 'CreateTime Asc', 'default' => 'CreateTime Asc'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页列表',
'description' => '分页列表',
'type' => 'object',
'properties' => [
'ResourceGroupList' => [
'title' => '获取到的资源组详情列表',
'description' => '获取到的资源组详情列表',
'type' => 'array',
'items' => [
'title' => '资源组详细信息',
'description' => '资源组详细信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '资源组唯一标识', 'description' => '资源组唯一标识', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
'Name' => ['title' => '资源组的名称', 'description' => '资源组的名称', 'type' => 'string', 'example' => 'common_resource_group'],
'Remark' => ['title' => '资源组的备注', 'description' => '资源组的备注', 'type' => 'string', 'example' => 'Create a general-purpose resource group for common tasks.'],
'PaymentType' => [
'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ',
'description' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'PrePaid',
'enum' => ['PrePaid', 'PostPaid'],
],
'Status' => [
'title' => '资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时；Freezed: 冻结；Starting: 启动中。',
'description' => '查询的资源组状态：'."\n"
."\n"
.'- Normal: 正常 (运行中/服务中)；'."\n"
.'- Stop: 冻结 (已到期)；'."\n"
.'- Deleted: 删除 (已释放/已销毁)；'."\n"
.'- Creating: 创建中；'."\n"
.'- CreateFailed: 创建失败；'."\n"
.'- Updating: 更新中 (扩容中/缩容中/变配中)；'."\n"
.'- UpdateFailed: 更新失败 (扩容失败/升级失败)；'."\n"
.'- Deleting: 删除中 (释放中/销毁中)；'."\n"
.'- DeleteFailed: 删除失败 (释放失败/销毁失败)；'."\n"
.'- Timeout: 操作超时；'."\n"
.'- Freezed：冻结；'."\n"
.'- Starting：启动中。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'Stop', 'Deleted', 'Creating', 'CreateFailed', 'Updating', 'UpdateFailed', 'Deleting', 'DeleteFailed', 'Timeout', 'Freezed', 'Starting'],
],
'Spec' => [
'title' => '资源组规格',
'description' => '资源组规格',
'type' => 'object',
'properties' => [
'Standard' => ['title' => '规格详情', 'description' => '规格详情', 'type' => 'string', 'example' => '2CU'],
'Amount' => ['title' => '数量', 'description' => '数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'ResourceGroupType' => [
'title' => '资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组',
'description' => '资源组类型：'."\n"
."\n"
.'- CommonV2：新版通用资源组；'."\n"
.'- ExclusiveDataIntegration：独享数据集成资源组；'."\n"
.'- ExclusiveScheduler：独享调度资源组；'."\n"
.'- ExclusiveDataService：独享数据服务资源组',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'CommonV2',
'enum' => ['CommonV2', 'ExclusiveDataIntegration', 'ExclusiveScheduler', 'ExclusiveDataService'],
],
'OrderInstanceId' => ['title' => '资源组的订单实例ID', 'description' => '资源组的订单实例ID', 'type' => 'string', 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX'],
'CreateUser' => ['title' => '创建该资源组的用户ID', 'description' => '创建该资源组的用户ID', 'type' => 'string', 'example' => '11075500042XXXXX'],
'CreateTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'DefaultVpcId' => ['title' => '通用资源组绑定的默认VPC ID', 'description' => '通用资源组绑定的默认VPC ID', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX'],
'DefaultVswicthId' => ['title' => '通用资源组绑定的默认交换机ID', 'description' => '通用资源组绑定的默认交换机ID', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX'],
'AliyunResourceGroupId' => ['title' => '阿里云资源组ID', 'description' => '阿里云资源组ID', 'type' => 'string', 'example' => 'rg-aek2kqofrgXXXXX'],
'AliyunResourceTags' => [
'title' => '阿里云标签列表',
'description' => '阿里云标签列表',
'type' => 'array',
'items' => [
'title' => '阿里云标签',
'description' => '阿里云标签',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'example' => 'Key'],
'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'example' => 'Value'],
],
],
],
],
],
],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100'],
'TotalCount' => ['title' => '全部数据条目', 'description' => '全部数据条目', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', '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\\": \\"Create a general-purpose resource group for common tasks.\\",\\n \\"PaymentType\\": \\"PrePaid\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Spec\\": {\\n \\"Standard\\": \\"2CU\\",\\n \\"Amount\\": 1\\n },\\n \\"ResourceGroupType\\": \\"CommonV2\\",\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"DefaultVpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"DefaultVswicthId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"AliyunResourceGroupId\\": \\"rg-aek2kqofrgXXXXX\\",\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"Key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
'title' => '获取资源组列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. **请确保在使用该接口前，已创建服务关联角色 AliyunServiceRoleForDataWorks。**',
'changeSet' => [
['createdAt' => '2025-02-21T06:57:06.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-02-10T12:42:36.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListResourceGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'],
],
],
],
],
],
'ListResources' => [
'summary' => '调用此接口，可以分页获取资源文件，也可以对资源进行筛选。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10002'],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => '负责人的ID，即工作空间管理员的账号UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号UID。', 'type' => 'string', 'required' => false, 'example' => '110755000425XXXX'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '筛选条件：资源类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Python'."\n"
.'- Jar'."\n"
.'- Archive'."\n"
.'- File',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Archive' => 'Archive', 'Jar' => 'Jar', 'File' => 'File', 'Python' => 'Python'],
'example' => 'Python',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '文件资源名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '131'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Resources' => [
'description' => '查询返回的资源列表',
'type' => 'array',
'items' => [
'description' => '资源列表元素',
'type' => 'object',
'properties' => [
'Name' => ['title' => '资源名称', 'description' => '资源名称', 'type' => 'string', 'deprecated' => false, 'example' => 'math.py', 'pattern' => '', 'default' => ''],
'ProjectId' => ['title' => '项目id', 'description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '344247', 'pattern' => '', 'default' => ''],
'Owner' => ['title' => '责任人', 'description' => '文件资源的责任人', 'type' => 'string', 'deprecated' => false, 'example' => '110755000425XXXX', 'pattern' => '', 'default' => ''],
'CreateTime' => ['description' => '文件资源的创建时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1724505917000'],
'ModifyTime' => ['title' => '修改时间', 'description' => '文件资源最近修改的时间戳。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '1724505917000', 'pattern' => '', 'default' => ''],
'DataSource' => [
'title' => '数据源',
'description' => '数据源',
'type' => 'object',
'properties' => [
'Name' => ['title' => '数据源名称', 'description' => '数据源名称', 'type' => 'string', 'deprecated' => false, 'example' => 'odps_first', 'pattern' => '', 'default' => ''],
'Type' => ['title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'deprecated' => false, 'example' => 'odps', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Script' => [
'title' => '脚本信息',
'description' => '脚本信息',
'type' => 'object',
'properties' => [
'Path' => ['title' => '脚本路径', 'description' => '脚本路径', 'type' => 'string', 'deprecated' => false, 'example' => 'root/demo', 'pattern' => '', 'default' => ''],
'Runtime' => [
'title' => '运行时',
'description' => '运行时',
'type' => 'object',
'properties' => [
'Command' => ['title' => '命令', 'description' => '命令，表示文件类型', 'type' => 'string', 'deprecated' => false, 'example' => 'ODPS_PYTHON', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '脚本id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '123348864897630XXXX'],
],
'deprecated' => false,
'required' => false,
],
'Type' => [
'title' => '资源类型',
'description' => '资源类型'."\n"
."\n"
.'可选值：'."\n"
."\n"
.'- Python'."\n"
.'- Jar'."\n"
.'- Archive'."\n"
.'- File',
'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' => '文件资源来源存储类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Local 本地'."\n"
.'- Oss 对象存储',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => ['Local' => 'Local', 'Oss' => 'Oss'],
'example' => 'Local',
'pattern' => '',
'default' => '',
'enum' => ['local', 'oss'],
],
'SourcePath' => ['title' => '文件目标存储路径', 'description' => '文件资源来源路径，type为local是为空。', 'type' => 'string', 'deprecated' => false, 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py', 'pattern' => '', 'default' => ''],
'TargetType' => [
'title' => '文件目标存储类型',
'description' => '文件目标存储类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- Gateway 网关'."\n"
.'- Oss 对象存储服务'."\n"
.'- Hdfs hdfs文件存储系统',
'type' => 'string',
'deprecated' => false,
'enumValueTitles' => ['Gateway' => 'Gateway', 'Hdfs' => 'Hdfs', 'Oss' => 'Oss'],
'example' => 'Oss',
'pattern' => '',
'default' => '',
'enum' => ['gateway', 'oss', 'hdfs'],
],
'TargetPath' => ['title' => '文件来源路径', 'description' => '文件目标存储路径', 'type' => 'string', 'deprecated' => false, 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py', 'pattern' => '', 'default' => ''],
'Id' => ['description' => '文件资源唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'example' => '631478864897630XXXX'],
],
],
],
],
],
],
],
],
],
'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' => '获取数据开发文件资源列表',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListRoutes' => [
'summary' => '获取网络资源的路由列表。',
'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' => '通用资源组唯一标识', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
[
'name' => 'NetworkId',
'in' => 'query',
'schema' => ['title' => '网络资源ID', 'description' => '网络资源ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '100'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码', 'description' => '分页页码', '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' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
."\n"
.'- Id (Desc/Asc)：路由ID'."\n"
.'- DestinationCidr (Desc/Asc)：目的CIDR'."\n"
.'- CreateTime (Desc/Asc)：创建时间'."\n"
."\n"
.'默认为CreateTime Asc', 'type' => 'string', 'required' => false, 'example' => 'CreateTime Asc', 'default' => 'CreateTime Asc'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'PagingInfo' => [
'title' => '分页列表',
'description' => '分页列表',
'type' => 'object',
'properties' => [
'RouteList' => [
'title' => '获取到的网络资源路由信息列表',
'description' => '获取到的网络资源路由信息列表',
'type' => 'array',
'items' => [
'title' => '路由详细信息',
'description' => '路由详细信息',
'type' => 'object',
'properties' => [
'Id' => ['title' => '路由ID', 'description' => '路由ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'ResourceGroupId' => ['title' => '所属资源组唯一标识符', 'description' => '所属资源组唯一标识符', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003****'],
'ResourceId' => ['title' => '网络资源唯一标识符', 'description' => '网络资源唯一标识符', 'type' => 'string', 'example' => 'ns-679XXXXXX'],
'DestinationCidr' => ['title' => '路由目的CIDR', 'description' => '路由目的CIDR', 'type' => 'string', 'example' => '192.168.0.0/16'],
'CreateTime' => ['title' => '创建时间，为64位时间戳', 'description' => '创建时间，为64位时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000'],
'NetworkId' => ['title' => '所属网络资源ID', 'description' => '所属网络资源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
],
],
],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100'],
'TotalCount' => ['title' => '全部数据条目', 'description' => '全部数据条目', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', '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' => '获取网络资源的路由列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-23T11:24:23.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListSchemas' => [
'summary' => '查询数据地图中给定数据库或maxcompute项目下的模式列表，当前支持maxcompute和holo类型。',
'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' => '父层级实体ID，可参考[元数据实体相关概念说明](~~2880092~~)，其中holo类型的`ParentMetaEntityId`可参考ListDatabases接口返回结果。'."\n"
."\n"
.'`ParentMetaEntityId`格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级空字符占位。'."\n"
."\n"
.'> 对于maxcompute类型，实例id层级使用空字符占位，数据库名称为maxcompute项目名称，要求该项目已开启三层模型。'."\n"
."\n"
.'几种常用类型ParentMetaEntityId格式参考如下'."\n"
.' '."\n"
.'`maxcompute-project:::project_name` （要求该项目已开启三层模型）'."\n"
."\n"
.'`holo-database:instance_id::database_name`'."\n"
."\n"
.'> 其中 '."\n"
.'`instance_id`: holo实例ID '."\n"
.'`database_name`: 数据库名称 '."\n"
.'`project_name`: maxcompute项目名', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-project:::project_name'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '名称，模糊匹配', 'description' => '名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['title' => '注释，模糊匹配', 'description' => '注释，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'test comment'],
],
[
'name' => 'Types',
'in' => 'query',
'style' => 'simple',
'schema' => [
'title' => '类型，精确匹配，支持多项，按照逻辑或的关系查询',
'description' => '类型，精确匹配，为空时查询所有类型。',
'type' => 'array',
'items' => ['description' => '模式类型。', 'type' => 'string', 'required' => false, 'example' => 'MANAGED'],
'required' => false,
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为CreateTime',
'description' => '排序字段，默认为CreateTime，枚举值，当前支持：'."\n"
."\n"
.'- CreateTime：创建时间。'."\n"
.'- ModifyTime：修改时间。'."\n"
.'- Name：名称。'."\n"
.'- Type：类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CreateTime',
'pattern' => '^[\\w.,;/@-]+$',
'default' => 'CreateTime',
'enum' => ['CreateTime', 'ModifyTime', 'Name', 'Type'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持：'."\n"
."\n"
.'- Asc：升序。'."\n"
.'- Desc：降序。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '235BBA5E-3428-XXXXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Schemas' => [
'description' => '数据库schema列表。',
'type' => 'array',
'items' => ['description' => '数据库schema。', '$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:123456XXX::test_project:default\\\\nholo-schema:h-abc123xxx::test_db:test_schema\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456XXX::test_project\\\\nholo-database:h-abc123xxx::test_db\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询数据地图数据库模式列表',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListSchemas',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListSecurityStrategies' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ControlModule',
'in' => 'formData',
'schema' => [
'description' => '**管控模块**'."\n",
'type' => 'string',
'required' => false,
'example' => 'DataQuery',
'default' => 'DataStudio',
'enum' => ['DataQuery', 'DataStudio'],
],
],
[
'name' => 'ControlSubModule',
'in' => 'formData',
'schema' => [
'description' => '**管控子模块**'."\n",
'type' => 'string',
'required' => false,
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码，从1开始。默认值为1。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '页大小，默认20'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20', 'maximum' => '100', 'minimum' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
'PagingInfo' => [
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码，默认1'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '页大小，默认20'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalCount' => ['description' => '总记录数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'SecurityStrategies' => [
'description' => '安全策略列表',
'type' => 'array',
'items' => [
'description' => '安全策略',
'type' => 'object',
'properties' => [
'Id' => ['description' => '策略ID', 'type' => 'string', 'example' => '12345'],
'Name' => ['description' => '策略名称', 'type' => 'string', 'example' => '默认数据分析策略'],
'Description' => ['description' => '策略描述', 'type' => 'string', 'example' => '控制数据分析模块的查询结果安全行为'],
'SchemaName' => [
'description' => 'Schema模板名称',
'type' => 'string',
'enumValueTitles' => ['DataStudioMyCatalogSecurityStrategySchema' => 'DataStudioMyCatalogSecurityStrategySchema', 'DataQuerySecurityStrategySchema' => 'DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema' => 'DataStudioSecurityStrategySchema'],
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
'ControlModule' => [
'description' => '**管控模块**',
'type' => 'string',
'example' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
'ControlSubModule' => [
'description' => '**管控子模块**',
'type' => 'string',
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
'ControlDwScope' => [
'description' => '**管控范围**（Workspace/Tenant）',
'type' => 'string',
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
'Workspaces' => [
'description' => '**关联工作空间ID列表**',
'type' => 'array',
'items' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '343434'],
],
'Enabled' => ['description' => '**是否启用**', 'type' => 'boolean', 'example' => 'false'],
'OriginPolicyId' => ['description' => '**系统默认策略来源ID**', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'Creator' => ['description' => '**创建者用户ID**', 'type' => 'string', 'example' => '203322746501002787'],
'Updater' => ['description' => '**最后更新者用户ID**', 'type' => 'string', 'example' => '203322746501002787'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2026-05-25T20:46:19'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2026-05-25T20:46:19'],
'Content' => [
'description' => '策略内容。内容受 SecurityStrategySchema 约束',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '当前策略关联的 SecurityStrategySchema.name',
'type' => 'string',
'example' => 'DataQuerySecurityStrategySchema',
'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'],
],
'DisplayName' => ['description' => '当前策略关联的 SecurityStrategySchema. displayName', 'type' => 'string', 'example' => '数据分析'],
'DisplayNameEn' => ['description' => '当前策略关联的 SecurityStrategySchema. displayNameEn', 'type' => 'string', 'example' => 'Data Query'],
'ControlModule' => [
'description' => '控制模块。当前策略关联的 SecurityStrategySchema.controlModule',
'type' => 'string',
'example' => 'DataQuery',
'enum' => ['DataQuery', 'DataStudio'],
],
'ControlSubModule' => [
'description' => '管控子模块。当前策略关联的 SecurityStrategySchema.controlSubModule',
'type' => 'string',
'example' => 'MyCatalog',
'enum' => ['MyCatalog'],
],
'ControlDwScope' => [
'description' => '**管控范围**'."\n",
'type' => 'string',
'enumValueTitles' => ['Tenant' => 'Tenant', 'Workspace' => 'Workspace'],
'example' => 'Tenant',
'enum' => ['Tenant', 'Workspace'],
],
'SystemPolicyName' => ['description' => '系统策略名称（非空时系统自动创建默认策略）'."\n", 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY'],
'SystemPolicyDisplayName' => ['description' => '系统策略显示名称'."\n", 'type' => 'string', 'example' => 'Default system generate data query policy'],
'Controllers' => [
'description' => '管控项列表，合法管控项取决于所选 Schema，参考 Controller定义 及 各Schema管控项列表'."\n",
'type' => 'array',
'items' => [
'description' => '管控项',
'type' => 'object',
'properties' => [
'Controller' => ['description' => '管控项标识符，取值见 各Schema管控项列表'."\n", 'type' => 'string', 'example' => 'viewCount'],
'DisplayName' => ['description' => '显示名称'."\n", 'type' => 'string', 'example' => '查询结果-单次展示记录值上限'],
'DisplayNameEn' => ['description' => '**英文显示名称**', 'type' => 'string', 'example' => 'Query Results - Single Display Record Limit'],
'Enable' => ['description' => '**是否启用该管控项**', 'type' => 'boolean'],
'ControllerValueType' => ['description' => '**值类型（Boolean/Integer/Long/String）**', 'type' => 'string', 'example' => 'Integer'],
'UserConfigValue' => ['description' => '**用户配置值，类型取决于ControllerValueType**', 'type' => 'any', 'example' => '20'],
'BasicEditionDefaultValue' => ['description' => '**基础版默认值**', 'type' => 'any', 'example' => '10000'],
'StandardEditionDefaultValue' => ['description' => '**标准版默认值**', 'type' => 'any', 'example' => '10000'],
'ProfessionalEditionDefaultValue' => ['description' => '专业版默认值'."\n", 'type' => 'any', 'example' => '10000'],
'EnterpriseEditionDefaultValue' => ['description' => '企业版默认值'."\n", 'type' => 'any', 'example' => '10000'],
'BasicEditionIntervalValue' => [
'description' => '基础版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'StandardEditionIntervalValue' => [
'description' => '标准版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'ProfessionalEditionIntervalValue' => [
'description' => '专业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'EnterpriseEditionIntervalValue' => [
'description' => '企业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '分页检索安全策略',
'summary' => '根据指定条件分页查询系统中的安全策略列表。需要Dataworks 租户管理员与安全管理员权限。',
'description' => '## 请求说明'."\n"
."\n"
.'- 该 API 用于分页检索系统中已配置的安全策略。'."\n"
.'- 可通过 `ControlModule` 和 `ControlSubModule` 参数过滤特定模块或子模块下的策略。'."\n"
.'- 分页参数包括 `PageNum` 和 `PageSize`，分别表示页码和每页大小，默认值分别为 1 和 20。'."\n"
.'- 如果需要进一步的分页控制，可以使用 `MaxResults` 和 `NextToken` 参数（私有参数）。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"SecurityStrategies\\": [\\n {\\n \\"Id\\": \\"12345\\",\\n \\"Name\\": \\"默认数据分析策略\\",\\n \\"Description\\": \\"控制数据分析模块的查询结果安全行为\\",\\n \\"SchemaName\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"Workspaces\\": [\\n 343434\\n ],\\n \\"Enabled\\": false,\\n \\"OriginPolicyId\\": 12,\\n \\"Creator\\": \\"203322746501002787\\",\\n \\"Updater\\": \\"203322746501002787\\",\\n \\"CreateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"UpdateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"Content\\": {\\n \\"Name\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"DisplayName\\": \\"数据分析\\",\\n \\"DisplayNameEn\\": \\"Data Query\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"SystemPolicyName\\": \\"SYSTEM_GENERATE_DEFAULT_DATA_QUERY\\",\\n \\"SystemPolicyDisplayName\\": \\"Default system generate data query policy\\",\\n \\"Controllers\\": [\\n {\\n \\"Controller\\": \\"viewCount\\",\\n \\"DisplayName\\": \\"查询结果-单次展示记录值上限\\",\\n \\"DisplayNameEn\\": \\"Query Results - Single Display Record Limit\\",\\n \\"Enable\\": true,\\n \\"ControllerValueType\\": \\"Integer\\",\\n \\"UserConfigValue\\": \\"20\\",\\n \\"BasicEditionDefaultValue\\": \\"10000\\",\\n \\"StandardEditionDefaultValue\\": \\"10000\\",\\n \\"ProfessionalEditionDefaultValue\\": \\"10000\\",\\n \\"EnterpriseEditionDefaultValue\\": \\"10000\\",\\n \\"BasicEditionIntervalValue\\": [\\n 0\\n ],\\n \\"StandardEditionIntervalValue\\": [\\n 0\\n ],\\n \\"ProfessionalEditionIntervalValue\\": [\\n 0\\n ],\\n \\"EnterpriseEditionIntervalValue\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListSkills' => [
'summary' => '分页查询当前账号下的Skill列表。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '本次请求返回的最大条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '分页 Token。首次查询不传；后续查询传上一次返回的 `NextToken` 获取下一页。'."\n", 'type' => 'string', 'required' => false, 'example' => '5'],
],
[
'name' => 'Q',
'in' => 'formData',
'schema' => ['description' => '搜索关键词，按 Skill 名称模糊匹配。'."\n", 'type' => 'string', 'required' => false, 'example' => 'analysis'],
],
[
'name' => 'Visibility',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '按可见性级别过滤，可传多个。'."\n",
'type' => 'array',
'items' => [
'description' => 'project id',
'type' => 'string',
'required' => false,
'example' => '123456',
'enum' => ['TENANT', 'PROJECT', 'USER'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'PagingInfo' => [
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '符合条件的总条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'MaxResults' => ['description' => '本次返回的最大条数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['description' => '下一页 Token，为空表示已到末页。'."\n", 'type' => 'string', 'example' => '5'],
'Skills' => [
'description' => 'Skill 列表。'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '**Skill 名称。**'."\n", 'type' => 'string', 'example' => 'my-skill'],
'Description' => ['description' => '**Skill 描述。**'."\n", 'type' => 'string', 'example' => '数据分析技能'],
'CreatorId' => ['description' => '**创建者 ID。**'."\n", 'type' => 'string', 'example' => '123456'],
'ModifierId' => ['description' => '**最近修改者 ID。**'."\n", 'type' => 'string', 'example' => '123456'],
'Visibility' => ['description' => '**可见性级别。**'."\n", 'type' => 'string', 'example' => 'TENANT'],
'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
'description' => '',
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '列出Skill',
'description' => '## 请求说明'."\n"
."\n"
.'该API用于分页查询当前账号下的Skill列表，支持通过搜索关键词、可见性级别等条件进行过滤。'."\n"
."\n"
.'- **Q**：可选参数，用于按Skill名称模糊匹配。'."\n"
.'- **Visibility**：可选参数，用于按可见性级别过滤，可以传递多个值。'."\n"
.'- **MaxResults**：可选参数，指定本次请求返回的最大条数。'."\n"
.'- **NextToken**：可选参数，用于分页查询时获取下一页的数据。首次查询时不传此参数；后续查询时传上一次返回的NextToken以获取下一页数据。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"5\\",\\n \\"Skills\\": [\\n {\\n \\"Name\\": \\"my-skill\\",\\n \\"Description\\": \\"数据分析技能\\",\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListTables' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '266735',
'abilityTreeNodes' => ['FEATUREdideE9OA4H'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ParentMetaEntityId',
'in' => 'query',
'schema' => ['title' => '父层级实体ID', 'description' => '父层级元数据实体ID，可参考ListDatabases/ListSchemas接口返回结果，以及[元数据实体相关概念说明](~~2880092~~)。'."\n"
."\n"
.'- 可为表所属数据库，`ParentMetaEntityId`格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}`，对于不存在的层级空字符占位。'."\n"
."\n"
.'- 也可为表所属数据库模式，`ParentMetaEntityId`格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录标识}:${数据库名称}:${模式名称}`，对于不存在的层级空字符占位'."\n"
."\n"
.'> - 只有数据库类型支持schema（`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`，其中maxcompute类型需要开启三层模型)时, `ParentMetaEntityId`才可使用数据库模式，否则只能使用数据库。'."\n"
.'> - 对于maxcompute和dlf类型，实例ID使用空字符占位。对于maxcompute类型，数据库名称即为maxcompute项目名称。'."\n"
.'> - starrocks类型的数据目录标识为目录名称，dlf类型的数据目录标识为目录ID, 其他类型不支持目录层级，可用空字符占位。'."\n"
."\n"
.'几种常用类型ParentMetaEntityId格式参考如下'."\n"
."\n"
.'- `maxcompute-project:::project_name`'."\n"
."\n"
.'- `maxcompute-schema:::project_name:schema_name` (仅项目开启三层模型时)'."\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`: 实例ID，对应数据源以实例模式注册时需要提供。'."\n"
.'> - `encoded_jdbc_url`: JDBC连接串的URLEncode编码,对应数据源以连接串方式注册时需要提供。'."\n"
.'> - `catalog_id`: dlf目录ID。'."\n"
.'> - `project_name`: maxcompute项目名称。'."\n"
.'> - `database_name`: 数据库名称。'."\n"
.'> - `schema_name`: schema名称。', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-project:::project_name'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '名称', 'description' => '名称，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'Comment',
'in' => 'query',
'schema' => ['title' => '注释', 'description' => '注释，模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
[
'name' => 'TableTypes',
'in' => 'query',
'style' => 'simple',
'schema' => [
'title' => '表类型',
'description' => '查询的表类型列表，为空时查询所有类型。',
'type' => 'array',
'items' => ['description' => '表类型，取值与数据库类型相关。', 'type' => 'string', 'required' => false, 'example' => 'TABLE'],
'required' => false,
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'title' => '排序字段，默认为CreateTime',
'description' => '排序字段，默认为CreateTime，枚举值，当前支持'."\n"
.'- CreateTime 创建时间'."\n"
.'- ModifyTime 修改时间'."\n"
.'- Name 名称'."\n"
.'- TableType 表类型',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CreateTime',
'default' => 'CreateTime',
'enum' => ['CreateTime', 'ModifyTime', 'Name', 'TableType'],
],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => [
'title' => '排序方向，默认为Asc',
'description' => '排序方向，默认为Asc，枚举值，当前支持'."\n"
.'- Asc 升序'."\n"
.'- Desc 降序',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Asc',
'default' => 'Asc',
'enum' => ['Asc', 'Desc'],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码，默认为1', 'description' => '分页页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页大小，默认为10，最大为100', 'description' => '分页大小，默认为10，最大为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
],
[
'name' => 'IncludeExtendedProperties',
'in' => 'query',
'schema' => ['type' => 'boolean'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E25887B7-579C-54A5-9C4F-83A****'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'PagingInfo' => [
'title' => '分页结果',
'description' => '分页结果。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'PageNumber' => ['description' => '分页页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Tables' => [
'title' => '数据表列表',
'description' => '数据表列表。',
'type' => 'array',
'items' => ['title' => '数据表详情', 'description' => '数据表详情。', '$ref' => '#/components/schemas/Table'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询数据地图数据表列表',
'summary' => '查询数据地图中的数据表列表。'."\n"
.'对于不支持schema级别的类型，支持查询给定数据库下的数据表列表；'."\n"
.'对于支持schema级别的类型，支持查询给定数据库/maxcompute项目/模式下的数据表列表。'."\n"
.'返回结果中仅包含数据表基础信息，不包含技术元数据与业务元数据信息。',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'responseParamsDescription' => '**注意**:'."\n"
."\n"
.'`Tables` 中返回的 `Table` 对象为精简结构，**不包含**以下属性：'."\n"
.' - `TechnicalMetadata`'."\n"
.' - `BusinessMetadata`'."\n"
."\n"
.'如果调用方需要获取表的技术元数据或业务元数据，必须进一步调用 `GetTable` API 获取完整的 `Table` 对象。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A****\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Tables\\": [\\n {\\n \\"Id\\": \\"dlf-table::catalog_id:database_name::table_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"dlf-database::catalog_id:database_name\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"test_user\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListTaskInstanceOperationLogs' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '240664',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'Date',
'in' => 'query',
'schema' => ['description' => '操作日期（精确到天），默认查询当天。支持查询过去31天内的操作日志。格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'."\n"],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'."\n"],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'OperationLogs' => [
'description' => '操作日志列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'User' => ['description' => '操作人的账号ID。', 'type' => 'string', 'example' => '1000'."\n"],
'CreateTime' => ['description' => '操作日志生成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'OperationSeq' => ['description' => '操作序列号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1111'],
'OperationContent' => ['description' => '操作内容。', 'type' => 'string', 'example' => 'Freeze tasks'],
'TaskInstanceId' => ['description' => '所操作的任务实例Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
],
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'."\n"],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'."\n"],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'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' => '获取任务实例的操作日志列表',
'summary' => '分页获取指定任务实例的操作日志列表。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。'."\n"
."\n"
.'仅支持查询过去31天内的操作日志。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListTaskInstances' => [
'summary' => '分页获取任务实例列表，也可以通过条件进行筛选查询。',
'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' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'."\n"],
],
[
'name' => 'Bizdate',
'in' => 'formData',
'schema' => ['description' => '业务日期。一般是周期实例定时时间的前一天的0点0分0秒，格式为毫秒级时间戳，如1743350400000。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710239005403'],
],
[
'name' => 'TaskId',
'in' => 'formData',
'schema' => ['description' => '对应任务的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'TaskIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '对应任务的ID列表，可根据任务Id批量查询任务实例。',
'type' => 'array',
'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
],
[
'name' => 'TaskName',
'in' => 'formData',
'schema' => ['description' => '对应任务的名称，支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'SQL node'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'TaskType',
'in' => 'formData',
'schema' => ['description' => '任务类型。各节点的TaskType取值，请参见[DataWorks节点合集](~~600169~~)。', 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL'],
],
[
'name' => 'RuntimeResource',
'in' => 'formData',
'schema' => ['description' => '资源组信息，这里请填入调度资源组标识符。', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n"],
],
[
'name' => 'WorkflowId',
'in' => 'formData',
'schema' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'."\n"],
],
[
'name' => 'UnifiedWorkflowInstanceId',
'in' => 'formData',
'schema' => ['description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'WorkflowInstanceType',
'in' => 'formData',
'schema' => [
'title' => '工作流实例类型',
'description' => '所属工作流实例的类型。'."\n"
.'- SmokeTest：测试'."\n"
.'- Manual：手动任务'."\n"
.'- SupplementData：补数据'."\n"
.'- ManualWorkflow：手动工作流'."\n"
.'- Normal：周期调度'."\n"
.'- TriggerWorkflow：触发式工作流',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal'."\n",
'enum' => ['Normal', 'ManualWorkflow', 'Manual', 'SupplementData', 'SmokeTest', 'TriggerWorkflow'],
],
],
[
'name' => 'WorkflowInstanceId',
'in' => 'formData',
'schema' => ['description' => '所属工作流实例的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'ProjectEnv',
'in' => 'formData',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '任务实例ID。任务实例存在重跑的情况，假如设置该参数，则返回包含重跑的历史信息，通过RunNumber区分每个历史信息。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务实例ID列表，可根据任务实例Id批量查询多个任务实例信息。',
'type' => 'array',
'items' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
],
[
'name' => 'TriggerType',
'in' => 'formData',
'schema' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：周期调度触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal'."\n",
'enum' => ['Scheduler', 'Manual'],
],
],
[
'name' => 'TriggerRecurrence',
'in' => 'formData',
'schema' => [
'description' => '触发时的运行模式，TriggerType=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'Skip', 'Pause'],
],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => ['description' => '排序字段。支持定时时间、开始时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\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"
.' 默认值：`Id Desc`', 'type' => 'string', 'required' => false, 'example' => 'Id Desc'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页的条目数，默认为10，最大为500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '任务实例的状态：'."\n"
.'- `NotRun`：未运行'."\n"
.'- `Running`：运行中'."\n"
.'- `Failure`：运行失败'."\n"
.'- `Success`：运行成功'."\n"
.'- `WaitTime`：等待时间'."\n"
.'- `WaitResource`：等待资源',
'type' => 'string',
'required' => false,
'example' => 'Success',
'enum' => ['NotRun', 'Running', 'Failure', 'Success', 'WaitTime', 'WaitResource'],
],
],
[
'name' => 'Filter',
'in' => 'formData',
'schema' => ['description' => '过滤器。JSON格式，多个过滤条件之间是"且"的关系。目前支持的字段有：`startedTimeStart, startedTimeEnd, finishedTimeStart, finishedTimeEnd, createTimeStart, createTimeEnd`', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "startedTimeStart": "1763481600000",'."\n"
.' "startedTimeEnd": "1763481600000",'."\n"
.' "finishedTimeStart": "1763481600000",'."\n"
.' "finishedTimeEnd": "1763481600000",'."\n"
.' "createTimeStart": "1763481600000",'."\n"
.' "createTimeEnd": "1763481600000"'."\n"
.'}'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TaskInstances' => [
'description' => '任务实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '对应任务的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n"],
'TaskType' => ['title' => '任务类型', 'description' => '对应任务的类型。', 'type' => 'string', 'example' => 'ODPS_SQL'."\n"],
'TaskName' => ['description' => '对应任务的名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'."\n"],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n"],
'WorkflowName' => ['description' => '所属工作流的名称。', 'type' => 'string', 'example' => 'Test workflow'."\n"],
'TriggerType' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Scheduler'."\n",
],
'TriggerRecurrence' => [
'description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal'."\n",
],
'WorkflowInstanceId' => ['description' => '所属工作流实例的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'UnifiedWorkflowInstanceId' => ['description' => '统一工作流实例Id，某次触发下某业务日期内的所有任务实例的该字段值相等。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowInstanceType' => [
'description' => '所属工作流实例的类型。'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- Manual：手动'."\n"
.'- ManualWorkflow：手动工作流'."\n"
.'- Normal：周期调度'."\n"
.'- ManualFlow：手动执行的业务流程',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal',
],
'Timeout' => ['description' => '任务执行超时时间，单位为秒。'."\n"
."\n"
.'注意：调度系统会对任务的设定值按小时取整。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'AllAllowed'."\n",
],
'RunNumber' => ['description' => '当前运行的次数，默认从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PeriodNumber' => ['description' => '周期序号。表示任务实例处于当天的第几轮周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'BaselineId' => ['description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RuntimeResource' => [
'description' => '实例关联资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'."\n"],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'."\n"],
],
],
'Runtime' => [
'description' => '实例运行时信息。',
'type' => 'object',
'properties' => [
'ProcessId' => ['description' => '运行唯一ID。', 'type' => 'string', 'example' => 'T3_123'."\n"],
'Gateway' => ['description' => '运行机器。', 'type' => 'string', 'example' => 'cn-shanghai.1.2'."\n"],
],
],
'DataSource' => [
'description' => '实例关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'."\n"],
],
],
'Status' => [
'title' => '实例运行状态',
'description' => '实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件检验'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检'."\n"
.'- WaitTrigger（等待外部触发，触发式节点会在等待时间后变成等待触发）',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Success',
],
'TriggerTime' => ['description' => '定时触发时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'Bizdate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'Id' => ['description' => '任务实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n"],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Prod',
],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ScriptParameters' => ['description' => '脚本参数列表。', 'type' => 'string', 'example' => 'para1=val1 para2=val2'],
'WaitingResourceTime' => ['description' => '进入等资源的时刻。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'WaitingTriggerTime' => ['description' => '进入等定时时间的时刻。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
],
'description' => '',
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', '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' => '获取任务实例列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-05-23T02:37:51.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-21T01:59:29.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListTaskInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'TaskInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:taskinstance/*'],
],
],
],
],
],
'ListTaskOperationLogs' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '240490',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'Date',
'in' => 'query',
'schema' => ['description' => '操作日期（精确到天），默认查询当天。支持查询过去31天内的操作日志。格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'."\n"],
],
[
'name' => 'ProjectEnv',
'in' => 'query',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'OperationLogs' => [
'description' => '操作日志列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'User' => ['description' => '操作人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '操作日志生成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'OperationSeq' => ['description' => '操作序列号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1111'],
'OperationContent' => ['description' => '操作内容。', 'type' => 'string', 'example' => 'Freeze tasks'],
'TaskId' => ['description' => '所操作的任务Id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
],
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'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' => '获取任务的操作日志列表',
'summary' => '分页获取指定任务的操作日志列表。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。'."\n"
."\n"
.'仅支持查询过去31天内的操作日志。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListTaskOperationLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListTasks' => [
'summary' => '分页获取任务列表，也可以通过条件进行筛选查询。',
'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' => '项目环境。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Prod' => '生产', 'Dev' => '开发'],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '名称，支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'SQL node'."\n"],
],
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务的ID列表，可根据任务Id批量查询任务。',
'type' => 'array',
'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'TaskType',
'in' => 'formData',
'schema' => ['description' => '任务类型。例如：'."\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', 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL'."\n"],
],
[
'name' => 'RuntimeResource',
'in' => 'formData',
'schema' => ['description' => '资源组信息，这里请填入调度资源组标识符。', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
],
[
'name' => 'WorkflowId',
'in' => 'formData',
'schema' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'TriggerType',
'in' => 'formData',
'schema' => [
'description' => '触发方式类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Scheduler' => '调度周期触发', 'Manual' => '手动触发'],
'example' => 'Scheduler'."\n",
'enum' => ['Scheduler', 'Manual'],
],
],
[
'name' => 'TriggerRecurrence',
'in' => 'formData',
'schema' => [
'description' => '触发时的运行模式，TriggerType=Scheduler时生效。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Pause' => '暂停', 'Skip' => '空跑', 'Normal' => '正常运行'],
'example' => 'Normal'."\n",
'enum' => ['Normal', 'Skip', 'Pause'],
],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => ['description' => '排序字段。支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
."\n"
.'- `ModifyTime (Desc/Asc)`'."\n"
.'- `CreateTime (Desc/Asc)`'."\n"
.'- `Id (Desc/Asc)`'."\n"
."\n"
.' 默认值：`Id Desc`', 'type' => 'string', 'required' => false, 'example' => 'Id Desc'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页的条目数，默认为10，最大为1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ResultModel',
'description' => 'ResultModel',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Tasks' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'."\n"],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'InstanceMode' => ['description' => '实例生成模式。'."\n"
."\n"
.'- T+1（第二天生成）'."\n"
.'- Immediately（立即生成）', 'type' => 'string', 'example' => 'T+1'],
'Type' => ['title' => '任务类型', 'description' => '任务类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位秒', 'description' => '任务执行超时时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。',
'type' => 'string',
'enumValueTitles' => ['AllDenied' => '失败或成功都不可重跑', 'FailureAllowed' => '只有失败可重跑', 'AllAllowed' => '失败或成功均可重跑'],
'example' => 'AllAllowed'."\n",
],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Trigger' => [
'title' => '任务触发方式',
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。',
'type' => 'string',
'enumValueTitles' => ['Scheduler' => '调度周期触发', 'Manual' => '手动触发'],
'example' => 'Scheduler'."\n",
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。',
'type' => 'string',
'enumValueTitles' => ['Pause' => '暂停', 'Skip' => '空跑', 'Normal' => '正常运行'],
'example' => 'Normal'."\n",
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'."\n"],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'."\n"],
],
],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'."\n"],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'."\n"],
],
],
'Id' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。',
'type' => 'string',
'enumValueTitles' => ['Prod' => '生产', 'Dev' => '开发'],
'example' => 'Prod',
],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ScriptParameters' => ['description' => '脚本参数列表。', 'type' => 'string', 'example' => 'para1=$bizdate para2=$[yyyymmdd] '],
],
'description' => '',
],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取任务列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-15T02:50:51.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\\\n\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\\\n\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ScriptParameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListUpstreamTaskInstances' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '240661',
'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'TaskInstances' => [
'description' => '任务实例列表。该字段已废弃，请使用UpstreamTaskInstances。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StepType' => ['title' => '依赖类型', 'description' => '依赖类型。'."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'TaskId' => ['description' => '对应任务的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'TaskType' => ['title' => '任务类型', 'description' => '对应任务的类型。', 'type' => 'string', 'example' => 'ODPS_SQL'."\n"],
'TaskName' => ['description' => '对应任务的名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowName' => ['description' => '所属工作流的名称。', 'type' => 'string', 'example' => 'Test workflow'],
'TriggerType' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Scheduler',
],
'TriggerRecurrence' => [
'description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal'."\n",
],
'WorkflowInstanceId' => ['description' => '所属工作流实例的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowInstanceType' => [
'description' => '所属工作流实例的类型。'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- Manual：手动'."\n"
.'- ManualWorkflow：手动工作流'."\n"
.'- Normal：周期调度'."\n"
.'- ManualFlow：手动执行的业务流程',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Normal'."\n",
],
'Timeout' => ['description' => '任务执行超时时间，单位为秒。'."\n"
."\n"
.'注意：调度系统会对任务的设定值按小时取整。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'AllAllowed'."\n",
],
'RunNumber' => ['description' => '当前运行的次数，默认从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PeriodNumber' => ['description' => '周期序号。表示任务实例处于当天的第几轮周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'BaselineId' => ['description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RuntimeResource' => [
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n"],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'."\n"],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'Runtime' => [
'description' => '实例运行时信息。',
'type' => 'object',
'properties' => [
'ProcessId' => ['description' => '运行唯一ID。', 'type' => 'string', 'example' => 'T3_123'],
'Gateway' => ['description' => '运行机器。', 'type' => 'string', 'example' => 'cn-shanghai.1.2'],
],
],
'DataSource' => [
'description' => '实例关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'Status' => [
'title' => '实例运行状态',
'description' => '实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件检验'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'Success'."\n",
],
'TriggerTime' => ['description' => '定时触发时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Bizdate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Id' => ['description' => '任务实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'deprecated' => true,
'enumValueTitles' => [],
'example' => 'Prod'."\n",
],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
'UpstreamTaskInstances' => [
'description' => '上游任务实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DependencyType' => ['title' => '依赖类型', 'description' => '依赖类型。'."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'TaskInstance' => [
'title' => '任务实例',
'description' => '任务实例的详细信息。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '对应任务的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'TaskType' => ['title' => '任务类型', 'description' => '对应任务的类型。', 'type' => 'string', 'example' => 'ODPS_SQL'],
'TaskName' => ['description' => '对应任务的名称。', 'type' => 'string', 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowName' => ['description' => '所属工作流的名称。', 'type' => 'string', 'example' => 'Test workflow'],
'TriggerType' => ['description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发', 'type' => 'string', 'example' => 'Scheduler'],
'TriggerRecurrence' => ['description' => '触发时的运行模式。TriggerType=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行', 'type' => 'string', 'example' => 'Normal'],
'WorkflowInstanceId' => ['description' => '所属工作流实例的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowInstanceType' => ['description' => '所属工作流实例的类型。'."\n"
.'- Normal：周期调度'."\n"
.'- Manual：手动任务'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- ManualWorkflow：手动工作流', 'type' => 'string', 'example' => 'Normal'],
'Timeout' => ['description' => '任务执行超时时间，单位为秒。'."\n"
."\n"
.'注意：调度系统会对任务的设定值按小时取整。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => ['title' => '任务是否允许重跑的配置', 'description' => '任务是否允许重跑的配置。', 'type' => 'string', 'example' => 'AllAllowed'],
'RunNumber' => ['description' => '当前运行的次数，默认从1开始。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PeriodNumber' => ['description' => '周期序号。表示任务实例处于当天的第几轮周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'BaselineId' => ['description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['description' => '任务运行优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RuntimeResource' => [
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'Runtime' => [
'description' => '实例运行时信息。',
'type' => 'object',
'properties' => [
'ProcessId' => ['description' => '运行唯一ID。', 'type' => 'string', 'example' => 'T3_123'],
'Gateway' => ['description' => '运行机器。', 'type' => 'string', 'example' => 'cn-shanghai.1.2'],
],
],
'DataSource' => [
'description' => '实例关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'Status' => ['title' => '实例运行状态', 'description' => '实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件检验'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检'."\n"
.'- WaitTrigger：等待外部触发，触发式节点会在等待时间后变成等待触发', 'type' => 'string', 'example' => 'Success'],
'TriggerTime' => ['description' => '定时触发时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Bizdate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'Id' => ['description' => '任务实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '目标数据源所属的环境。取值如下：'."\n"
.'- Dev：开发环境。'."\n"
.'- Prod：生产环境。', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'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' => '获取上游任务实例列表',
'summary' => '分页获取指定任务实例的上游任务实例列表。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'deprecated' => false,
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'Tasks' => [
'description' => '任务列表。该字段已废弃，请使用UpstreamTasks。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'SQL node'."\n"],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'InstanceMode' => ['description' => '实例生成模式。'."\n"
.'- T+1：第二天生成'."\n"
.'- Immediately：立即生成', 'type' => 'string', 'example' => 'T+1'],
'Type' => ['title' => '任务类型', 'description' => '任务类型。', 'type' => 'string', 'example' => 'ODPS_SQL'."\n"],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最小值1，最大值8。取值越大，优先级越高。默认优先级为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位秒', 'description' => '任务执行超时时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => [
'title' => '任务是否允许重跑的配置',
'description' => '任务是否允许重跑的配置。',
'type' => 'string',
'enumValueTitles' => ['AllDenied' => '失败或成功都不可重跑', 'FailureAllowed' => '只有失败可重跑', 'AllAllowed' => '失败或成功均可重跑'],
'example' => 'AllAllowed',
],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Trigger' => [
'title' => '任务触发方式',
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。',
'type' => 'string',
'enumValueTitles' => ['Scheduler' => '调度周期触发', 'Manual' => '手动触发'],
'example' => 'Scheduler',
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。',
'type' => 'string',
'enumValueTitles' => ['Pause' => '暂停', 'Skip' => '空跑', 'Normal' => '正常运行'],
'example' => 'Normal',
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'."\n"],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'."\n"],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'."\n"],
'Timezone' => ['description' => '时区。', 'type' => 'string', 'example' => 'Asia/Shanghai'],
],
],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'."\n"],
],
],
'Id' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n"],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ProjectEnv' => [
'description' => '项目环境。该字段已废弃，请使用EnvType。',
'type' => 'string',
'deprecated' => true,
'enumValueTitles' => ['Prod' => '生产', 'Dev' => '开发'],
'example' => 'Prod',
],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'StepType' => ['description' => '依赖类型。'."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'ModifyTime' => ['description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n"],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
'UpstreamTasks' => [
'description' => '上游任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DependencyType' => ['title' => '依赖类型', 'description' => '依赖类型。'."\n"
."\n"
.'- Normal：同周期依赖'."\n"
.'- CrossCycle：跨周期依赖', 'type' => 'string', 'example' => 'Normal'],
'Task' => [
'description' => '任务的详细信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'InstanceMode' => ['description' => '生成实例的模式'."\n"
.'- T+1'."\n"
.'- Immediately', 'type' => 'string', 'example' => 'T+1'],
'Type' => ['title' => '任务类型', 'description' => '任务类型', 'type' => 'string', 'example' => 'ODPS_SQL'],
'BaselineId' => ['title' => '基线ID', 'description' => '基线ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Priority' => ['title' => '任务优先级，最大值8，最小值1', 'description' => '任务优先级，最大值8，最小值1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Timeout' => ['title' => '任务执行超时时间，单位秒', 'description' => '任务执行超时时间，单位秒', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'RerunMode' => ['title' => '任务是否允许重跑的配置', 'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑', 'type' => 'string', 'example' => 'AllAllowed'."\n"],
'RerunTimes' => ['title' => '重试次数', 'description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'RerunInterval' => ['title' => '重试时间间隔，单位秒', 'description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Trigger' => [
'title' => '任务触发方式',
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发', 'type' => 'string', 'example' => 'Scheduler'],
'Recurrence' => ['description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行', 'type' => 'string', 'example' => 'Normal'."\n"],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'],
'Timezone' => ['description' => '时区。', 'type' => 'string', 'example' => 'Asia/Shanghai'],
],
],
'RuntimeResource' => [
'title' => '运行环境配置，如资源组信息',
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'example' => '0.25'],
],
],
'DataSource' => [
'title' => '数据源',
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'example' => 'mysql_test'],
],
],
'Id' => ['description' => '任务的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
],
],
],
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
'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' => '获取上游任务列表',
'summary' => '分页获取指定任务的上游任务列表。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-13T08:44:56.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ListWorkflowDefinitions' => [
'summary' => '分页获取数据开发工作流列表，也可以根据筛选条件对工作流进行筛选。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '筛选条件：工作流的类型，未填写则默认为CycleWorkflow'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- CycleWorkflow'."\n"
.'- ManualWorkflow',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CycleWorkflow',
'default' => 'CycleWorkflow',
],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => '负责人的ID，即工作空间管理员的账号UID。您可登录阿里云控制台后，在账号管理的安全管理中查看账号UID。', 'type' => 'string', 'required' => false, 'example' => '110755000425XXXX'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '工作流的名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页显示的条数，默认为10条，最大为100条。', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。用于定位日志，排查问题。'."\n", 'type' => 'string', 'example' => '8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX'],
'PagingInfo' => [
'description' => '分页信息',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '满足条件的数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '227'],
'PageSize' => ['description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '请求的数据页数，用于翻页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'WorkflowDefinitions' => [
'description' => '查询到的工作流列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProjectId' => ['title' => '所属项目空间', 'description' => '工作流所在DataWorks空间的ID。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => true, 'example' => '4710', 'pattern' => '', 'default' => ''],
'Owner' => ['title' => '责任人', 'description' => '责任人', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => '110755000425XXXX', 'pattern' => '', 'default' => ''],
'CreateTime' => ['title' => '创建时间', 'description' => '创建工作流时间戳', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '1698057323000', 'pattern' => '', 'default' => ''],
'ModifyTime' => ['title' => '修改时间', 'description' => '最近修改工作流的时间戳', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '1698057323000', 'pattern' => '', 'default' => ''],
'Description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => 'Workflow description', 'pattern' => '', 'default' => ''],
'Type' => [
'title' => '工作流类型',
'description' => '工作流类型'."\n"
."\n"
.'可选值'."\n"
."\n"
.'- CycleWorkflow'."\n"
.'- ManualWorkflow',
'type' => 'string',
'deprecated' => false,
'required' => false,
'enumValueTitles' => [],
'example' => 'CycleWorkflow',
'pattern' => '',
'default' => '',
'enum' => ['CycleWorkflow', 'ManualWorkflow'],
],
'Script' => [
'title' => '脚本信息',
'description' => '脚本信息',
'type' => 'object',
'properties' => [
'Path' => ['title' => '脚本路径', 'description' => '脚本路径', 'type' => 'string', 'deprecated' => false, 'example' => 'XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo', 'pattern' => '', 'default' => ''],
'Runtime' => [
'title' => '运行时',
'description' => '运行时',
'type' => 'object',
'properties' => [
'Command' => ['title' => '命令', 'description' => '命令', 'type' => 'string', 'deprecated' => false, 'example' => 'WORKFLOW', 'pattern' => '', 'default' => ''],
],
'deprecated' => false,
],
'Id' => ['description' => '脚本id。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '698002781368644XXXX'],
],
'deprecated' => false,
'required' => false,
],
'Name' => ['title' => '名称', 'description' => '工作流名称', 'type' => 'string', 'deprecated' => false, 'required' => false, 'example' => 'OpenAPI test workflow Demo', 'pattern' => '', 'default' => ''],
'Id' => ['description' => '工作流唯一标识。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'deprecated' => false, 'example' => '463497880880954XXXX'],
],
'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' => '获取数据开发工作流列表',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListWorkflowInstances' => [
'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' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
[
'name' => 'BizDate',
'in' => 'formData',
'schema' => ['description' => '业务日期。一般是周期实例定时时间的前一天的0点0分0秒，格式为毫秒级时间戳，如1743350400000。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710239005403'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'title' => '工作流实例类型',
'description' => '工作流实例的类型。'."\n"
.'- Normal：周期调度'."\n"
.'- Manual：手动任务'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- ManualWorkflow：手动工作流'."\n"
.'- TriggerWorkflow：触发式工作流',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
'default' => 'Normal',
'enum' => ['Normal', 'ManualWorkflow', 'Manual', 'SupplementData', 'SmokeTest', 'TriggerWorkflow'],
],
],
[
'name' => 'WorkflowId',
'in' => 'formData',
'schema' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'UnifiedWorkflowInstanceId',
'in' => 'formData',
'schema' => ['description' => '统一工作流实例Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '名称。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'WorkflowInstance1'],
],
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作流实例ID列表，可根据工作流实例Id批量查询多个工作流实例信息。',
'type' => 'array',
'items' => ['description' => '工作流实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '责任人的账号ID。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => ['description' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
.'- TriggerTime (Desc/Asc)'."\n"
.'- StartedTime (Desc/Asc)'."\n"
.'- FinishedTime (Desc/Asc)'."\n"
.'- CreateTime (Desc/Asc)'."\n"
.'- Id (Desc/Asc)'."\n"
."\n"
.'默认值：Id Desc', 'type' => 'string', 'required' => false, 'example' => 'Id Desc'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '标签列表，多个标签中满足一个即会返回结果。',
'type' => 'array',
'items' => ['description' => '标签。格式为：`key:value`。value为空时格式为：`key:`', 'type' => 'string', 'required' => false, 'example' => 'key:value'],
'required' => false,
],
],
[
'name' => 'Filter',
'in' => 'formData',
'schema' => ['description' => '过滤器。JSON格式，多个过滤条件之间是"且"的关系。目前支持的字段有：`status, executionDate`。', 'type' => 'string', 'required' => false, 'example' => '{ '."\n"
.' "status": "Success",'."\n"
.' "executionDate": "1763481600000"'."\n"
.'}'],
],
[
'name' => 'EnvType',
'in' => 'formData',
'schema' => [
'type' => 'string',
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'WorkflowInstances' => [
'description' => '工作流实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '工作流实例的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'WorkflowTaskInstanceId' => ['description' => '工作流实例对应的任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'UnifiedWorkflowInstanceId' => ['description' => '统一工作流实例Id，某次触发下某业务日期内的所有工作流实例的该字段值相等。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'WorkflowInstance1'],
'Type' => ['title' => '工作流类型', 'description' => '工作流实例的类型。'."\n"
.'- Normal：周期调度'."\n"
.'- Manual：手动任务'."\n"
.'- SmokeTest：测试'."\n"
.'- SupplementData：补数据'."\n"
.'- ManualWorkflow：手动工作流'."\n"
.'- TriggerWorkflow：触发式工作流', 'type' => 'string', 'example' => 'Normal'],
'Status' => ['description' => '工作流实例运行状态。'."\n"
.'- NotRun：未运行'."\n"
.'- Running：运行中'."\n"
.'- WaitTime：等待TriggerTime到来'."\n"
.'- CheckingCondition：分支条件检验'."\n"
.'- WaitResource：等待资源'."\n"
.'- Failure：执行失败'."\n"
.'- Success：执行成功'."\n"
.'- Checking：下发给数据质量校检', 'type' => 'string', 'example' => 'Success'],
'BizDate' => ['description' => '业务日期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'StartedTime' => ['description' => '开始运行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'FinishedTime' => ['description' => '完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod(生产)'."\n"
.'- Dev(开发)', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '工作流的责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '100'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '100'],
'WorkflowParameters' => ['description' => '工作流参数。', 'type' => 'string', 'example' => '周期工作流：'."\n"
.'key1=value1 key2=value2'."\n"
.'手动业务流程：'."\n"
.'{"key1":"value1", "key2": "value2"}'],
'WorkflowId' => ['description' => '所属工作流的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Tags' => [
'title' => '任务标签',
'description' => '任务标签',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流实例列表',
'summary' => '分页获取工作流实例列表，也可以通过条件进行筛选查询。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"WorkflowInstances\\": [\\n {\\n \\"Id\\": 1234,\\n \\"WorkflowTaskInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Name\\": \\"WorkflowInstance1\\",\\n \\"Type\\": \\"Normal\\",\\n \\"Status\\": \\"Success\\",\\n \\"BizDate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"100\\",\\n \\"ModifyUser\\": \\"100\\",\\n \\"WorkflowParameters\\": \\"周期工作流：\\\\nkey1=value1 key2=value2\\\\n手动业务流程：\\\\n{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"WorkflowId\\": 1234,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]',
],
'ListWorkflows' => [
'summary' => '分页获取工作流列表，也可以通过条件进行筛选查询。',
'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' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
[
'name' => 'EnvType',
'in' => 'formData',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作流ID列表，可根据工作流Id批量查询多个工作流信息。',
'type' => 'array',
'items' => ['description' => '工作流ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '名称。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'Workflow1'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '责任人的账号ID。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'TriggerType',
'in' => 'formData',
'schema' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler'."\n"
.'- Manual'."\n"
.'- TriggerWorkflow',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Scheduler',
'default' => 'Scheduler',
'enum' => ['Scheduler', 'Manual', 'TriggerWorkflow'],
],
],
[
'name' => 'SortBy',
'in' => 'formData',
'schema' => ['description' => '排序字段。支持修改时间、创建时间等字段，格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n"
.'- ModifyTime (Desc/Asc)'."\n"
.'- CreateTime (Desc/Asc)'."\n"
.'- Id (Desc/Asc)'."\n"
."\n"
.'默认值：Id Desc', 'type' => 'string', 'required' => false, 'example' => 'Id Desc'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页的条目数，默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码，从1开始，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '标签列表，多个标签中满足一个即会返回结果。',
'type' => 'array',
'items' => ['description' => '标签。格式为：`key:value`。value为空时格式为：`key:`', 'type' => 'string', 'required' => false, 'example' => 'key:value'],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'PagingInfo' => [
'description' => '分页信息。',
'type' => 'object',
'properties' => [
'Workflows' => [
'description' => '工作流列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '工作流的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'],
'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'Workflow1'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'test'],
'Trigger' => [
'description' => '触发方式。',
'type' => 'object',
'properties' => [
'Type' => ['title' => '`Scheduler` 周期触发', 'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发', 'type' => 'string', 'example' => 'Scheduler'],
'Recurrence' => ['description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行', 'type' => 'string', 'example' => 'Normal'],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。', 'type' => 'string', 'example' => '9999-01-01 00:00:00'],
],
],
'Parameters' => ['description' => '参数列表。', 'type' => 'string', 'example' => 'para1=$bizdate para2=$[yyyymmdd] '],
'ClientUniqueCode' => ['description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', 'type' => 'string', 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx'],
'ProjectId' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EnvType' => ['description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发', 'type' => 'string', 'example' => 'Prod'],
'Owner' => ['description' => '责任人的账号ID。', 'type' => 'string', 'example' => '1000'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'ModifyTime' => ['description' => '修改时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'],
'CreateUser' => ['description' => '创建用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'ModifyUser' => ['description' => '修改用户的账号ID。', 'type' => 'string', 'example' => '1000'],
'Tags' => [
'title' => '任务标签',
'description' => '任务标签',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'value1'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'TotalCount' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PageSize' => ['description' => '每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNumber' => ['description' => '页码。', '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' => '获取工作流列表',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'LoadAgentSession' => [
'summary' => '加载已存在会话的历史消息，以 SSE 流式返回。会话不存在时会通过 SSE 输出一条 code 为 400 的 JSONRPCResponse.error。Content-Type 为 text/event-stream。适用于恢复会话上下文场景。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '4as3dasf654a'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '目标会话 ID，不存在会返回 SSE error 帧'."\n", 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34'],
'Meta' => [
'description' => 'DataWorks的ACP扩展参数',
'type' => 'object',
'properties' => [
'IsReload' => ['description' => '是否是断点续传场景，在SSE流不稳定的场景下，比如网络不稳定，导致SSE中途断了，可以基于该标志标识从断点点位置重新拉取SSE返回数据', 'type' => 'boolean', 'required' => false, 'example' => 'true or false'],
'BeginLogOffset' => ['description' => '断点续传场景下，基于指定的位置拉取SSE的后续输出', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0D41C608-0C60-5EB0-B986-1460909CF642'],
'Timestamp' => ['description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1769479322828'],
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'example' => '676303114031776'],
'Result' => ['description' => 'SSE的帧结果集，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"stopReason":"end_turn"}'],
'Error' => ['description' => 'SSE 的帧信息错误提示，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}'],
'Method' => ['description' => 'SSE的method，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'string', 'example' => 'session/update'],
'Params' => ['description' => 'SSE的params，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '加载恢复Agent会话详情',
'description' => '## 请求说明'."\n"
.'- 该接口用于恢复指定会话的详情，并通过SSE（Server-Sent Events）以流式方式返回Agent的响应。'."\n"
.'- 如果目标会话不存在，则会返回一个错误帧，错误码为400。'."\n"
.'- 响应中包含Agent处理请求的过程信息，如消息分片、思考过程、工具调用状态更新等。'."\n"
.'- `stopReason`字段指示了Agent停止本轮对话的原因，可能值包括但不限于达到最大轮次限制、被取消等。'."\n"
.'- 返回的内容符合开源协议Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D41C608-0C60-5EB0-B986-1460909CF642\\",\\n \\"Timestamp\\": 1769479322828,\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"676303114031776\\",\\n \\"Result\\": \\"{\\\\\\"stopReason\\\\\\":\\\\\\"end_turn\\\\\\"}\\",\\n \\"Error\\": \\"{\\\\\\"code\\\\\\": 400, \\\\\\"errorCode\\\\\\": \\\\\\"0x50000000001\\\\\\", \\\\\\"message\\\\\\": \\\\\\"not exist session\\\\\\", \\\\\\"data\\\\\\": null}\\",\\n \\"Method\\": \\"session/update\\",\\n \\"Params\\": \\"{\\\\\\"sessionId\\\\\\":\\\\\\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\\\\\\",\\\\\\"update\\\\\\":{\\\\\\"sessionUpdate\\\\\\":\\\\\\"agent_message_chunk\\\\\\",\\\\\\"content\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"text\\\\\\",\\\\\\"text\\\\\\":\\\\\\"hello world\\\\\\"}}}\\"\\n}","type":"json"}]',
],
'MoveFunction' => [
'summary' => '调用此接口，可以将指定udf函数移动到数据开发目录的目标路径。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => 'udf函数的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '543217824470354XXXX'],
],
[
'name' => 'Path',
'in' => 'formData',
'schema' => ['description' => '移动的目标路径，不需要带函数名称。'."\n"
."\n"
.'例如将test函数的路径变成到root/demo/test，则此参数需要填写root/demo', 'type' => 'string', 'required' => true, 'example' => 'root/demo'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '移动数据开发函数路径',
'changeSet' => [
['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'MoveNode' => [
'summary' => '调用此接口，可以将指定的数据开发节点的路径移动到指定位置。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '652567824470354XXXX'],
],
[
'name' => 'Path',
'in' => 'formData',
'schema' => ['description' => '移动的目标路径，不需要带节点名。'."\n"
."\n"
.'例如将test节点的路径变成到root/demo/test，则此参数需要填写root/demo', 'type' => 'string', 'required' => true, 'example' => 'root/demo'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX'],
'Success' => ['description' => '调用是否成功：'."\n"
."\n"
.'- true：是'."\n"
."\n"
.'- false：否', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '移动数据开发节点路径',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'MoveResource' => [
'summary' => '调用此接口，可以将指定数据开发文件资源移动到指定的数据开发目录中。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发文件资源唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '652567824470354XXXX'],
],
[
'name' => 'Path',
'in' => 'formData',
'schema' => ['description' => '移动的目标路径，不需要带文件资源名称。'."\n"
."\n"
.'例如将math.py文件的路径变成到root/demo/math.py，则此参数需要填写root/demo', 'type' => 'string', 'required' => true, 'example' => 'root/demo'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID，用于后续错误排查使用。', 'type' => 'string', 'example' => 'F332BED4-DD73-5972-A9C2-642BA6CFXXXX'],
'Success' => ['description' => '调用是否成功。'."\n"
."\n"
.'- true：调用成功'."\n"
."\n"
.'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F332BED4-DD73-5972-A9C2-642BA6CFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '移动数据开发文件资源路径',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'MoveWorkflowDefinition' => [
'summary' => '调用此接口，可以将指定的数据开发工作流移动到数据开发目录的目标路径。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发工作流的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '543217824470354XXXX'],
],
[
'name' => 'Path',
'in' => 'formData',
'schema' => ['description' => '移动的目标路径，不需要带工作流名称。'."\n"
."\n"
.'例如将test工作流的路径变成到root/demo/test，则此参数需要填写root/demo', 'type' => 'string', 'required' => true, 'example' => 'root/demo'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '05ADAF4F-7709-5FB1-B606-3513483FXXXX'],
'Success' => ['description' => '请求是否成功：'."\n"
.'- true（成功）'."\n"
.'- false（失败）', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05ADAF4F-7709-5FB1-B606-3513483FXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '移动数据开发工作流路径',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'PreviewDatasetVersion' => [
'summary' => '预览指定版本数据集内容，当前仅支持OSS类型数据集下文本文件预览'."\n"
.'当前支持的MIME类型有'."\n"
.'1. application/json'."\n"
.'2. application/xml'."\n"
.'3. text/html'."\n"
.'4. text/plain'."\n"
.'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' => '数据集版本ID', 'type' => 'string', 'required' => true, 'example' => ' '."\n"
.'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n"
.':2'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485DXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'PreviewResult' => [
'title' => '预览结果',
'description' => '预览结果',
'type' => 'object',
'properties' => [
'SupportPreview' => ['title' => '是否支持预览', 'description' => '是否支持预览', 'type' => 'boolean', 'example' => 'true'],
'MimeType' => ['title' => 'MIME多媒体类型', 'description' => 'MIME多媒体类型', 'type' => 'string', 'example' => 'text/plain'],
'FileName' => ['title' => '预览文件名称', 'description' => '预览文件名称', 'type' => 'string', 'example' => 'parth/data.csv'],
'Content' => ['title' => '预览内容', 'description' => '预览内容', 'type' => 'string', 'example' => 'this is content'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '预览数据集版本内容',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:PreviewDatasetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485DXXX\\",\\n \\"Success\\": true,\\n \\"PreviewResult\\": {\\n \\"SupportPreview\\": true,\\n \\"MimeType\\": \\"text/plain\\",\\n \\"FileName\\": \\"parth/data.csv\\",\\n \\"Content\\": \\"this is content\\"\\n }\\n}","type":"json"}]',
],
'PromptAgentSession' => [
'summary' => '向已有会话发送用户Prompt并流式返回Agent响应。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREdideEWGMTH'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Jsonrpc',
'in' => 'formData',
'schema' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'required' => false, 'example' => '1021418411'],
],
[
'name' => 'Params',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '业务参数',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '目标会话 ID，不存在会返回 SSE error 帧'."\n", 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34'],
'Prompt' => [
'description' => '用户消息内容块数组，参考：https://agentclientprotocol.com/protocol/content',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => '**内容块类型**'."\n", 'type' => 'string', 'required' => false, 'example' => 'text'],
'Text' => ['description' => '**文本内容**'."\n", 'type' => 'string', 'required' => false, 'example' => 'Sales in the last 7 days'],
'Uri' => ['description' => '文件的URI。', 'type' => 'string', 'required' => false, 'example' => 'oss://${bucket}/${ossKey}'],
'Name' => ['description' => '文件名', 'type' => 'string', 'required' => false, 'example' => 'xxx.csv'],
'MimeType' => ['description' => '文件MIME类型', 'type' => 'string', 'required' => false, 'example' => 'text/csv'],
'Size' => ['description' => '文件的大小，单位：byte', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1231231'],
'Title' => ['description' => '文件名称', 'type' => 'string', 'required' => false, 'example' => 'Sales_Order_Details.csv'],
'Description' => ['description' => '文件描述', 'type' => 'string', 'required' => false, 'example' => 'Sales_Order_Details.csv'],
'Meta' => [
'description' => 'DataWorks扩展的Prompt元信息',
'type' => 'object',
'properties' => [
'Hide' => ['description' => '该Prompt是否对用户隐藏不显示。比如在Chat对话框中用户提问了一句话：近7天的销售金额，然后在调用OpenAPI之前，调用系统通过RAG召回了一些业务领域知识，需要补充在Agent上下文里面，但是又不想回显给用户看，此时可以把该值设置成true', 'type' => 'boolean', 'required' => false, 'example' => 'true or false'],
],
'required' => false,
],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'Meta' => [
'description' => '扩展元信息'."\n",
'type' => 'object',
'properties' => [
'Context' => ['description' => 'Map类型，对于自定义Agent场景下，有些占位符参数可以通过该值进行替换', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
.' "key1": "value1",'."\n"
.' "key2": "value2"'."\n"
.'}'],
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D5D70885-7CC7-594A-80C7-2EF1B00FFB4B'],
'Timestamp' => ['description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1747447032'],
'Jsonrpc' => ['description' => 'JSON-RPC 版本，固定 2.0', 'type' => 'string', 'example' => '2.0'],
'Id' => ['description' => '请求方传入的 id，原样回显', 'type' => 'string', 'example' => '631478864897630XXXX'],
'Result' => ['description' => 'SSE 的帧结果集，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"stopReason":"end_turn"}'."\n"],
'Error' => ['description' => 'SSE 的帧信息错误提示，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}'],
'Method' => ['description' => 'SSE 的 method，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'string', 'example' => 'session/update'],
'Params' => ['description' => 'SSE 的 params，返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '发送会话Prompt',
'description' => '## 请求说明'."\n"
.'- 该API用于向指定的会话ID发送用户的Prompt，并以SSE（Server-Sent Events）流式方式接收来自Agent的响应。'."\n"
.'- 响应可能包括消息分片、思考过程、工具调用状态更新等信息。'."\n"
.'- 如果指定的会话不存在，将通过SSE错误帧返回400错误。'."\n"
.'- `stopReason`字段指示了Agent停止本轮对话的原因。'."\n"
.'- 支持多种类型的内容块作为Prompt输入，如文本、OSS文件下载链接等。'."\n"
.'- 可选地提供额外元信息`Meta`来传递更多上下文给服务端。'."\n"
.'- 返回的内容符合开源协议 Agent Client Protocol (ACP) 的规范，具体可以参考：https://agentclientprotocol.com'."\n"
.'- ** 请确保在使用该接口前，已充分了解Data Agent产品的收费方式和价格 ** ：https://help.aliyun.com/zh/dataworks/dataworks-data-agent-agent-billing',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'dataworks:PromptAgentSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5D70885-7CC7-594A-80C7-2EF1B00FFB4B\\",\\n \\"Timestamp\\": 1747447032,\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"631478864897630XXXX\\",\\n \\"Result\\": \\"{\\\\\\"stopReason\\\\\\":\\\\\\"end_turn\\\\\\"}\\\\n\\",\\n \\"Error\\": \\"{\\\\\\"code\\\\\\": 400, \\\\\\"errorCode\\\\\\": \\\\\\"0x50000000001\\\\\\", \\\\\\"message\\\\\\": \\\\\\"not exist session\\\\\\", \\\\\\"data\\\\\\": null}\\",\\n \\"Method\\": \\"session/update\\",\\n \\"Params\\": \\"{\\\\\\"sessionId\\\\\\":\\\\\\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\\\\\\",\\\\\\"update\\\\\\":{\\\\\\"sessionUpdate\\\\\\":\\\\\\"agent_message_chunk\\\\\\",\\\\\\"content\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"text\\\\\\",\\\\\\"text\\\\\\":\\\\\\"hello world\\\\\\"}}}\\"\\n}","type":"json"}]',
],
'RemoveEntityFromMetaCollection' => [
'summary' => '从数据地图集合中移除实体对象，集合支持数据地图类目和数据专辑，实体当前仅支持数据表类型。'."\n"
.'从数据专辑移除实体时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。',
'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' => '集合对象Id，可参考ListMetaCollections接口返回结果', 'type' => 'string', 'required' => false, 'example' => 'as78d756asd'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '实体Id，目前仅支持表类型，可参考ListTables接口返回结果', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
],
'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' => '从数据地图集合中移除实体对象',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'RemoveTaskInstanceDependencies' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '245921',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'UpstreamTaskInstanceIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '上游任务实例ID列表。',
'type' => 'array',
'items' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'Success' => ['description' => '操作是否成功。', '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' => '移除任务实例的依赖关系',
'summary' => '批量移除某任务实例的多个上游依赖关系。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'RenameFunction' => [
'summary' => '调用此接口，可以对指定的udf函数进行重命名。',
'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' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10002'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发udf函数的唯一标识。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '543217824470354****'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '希望重命名的名称', 'type' => 'string', 'required' => true, 'example' => 'Rename'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的唯一标识，用于后续错误排查使用。', 'type' => 'string', 'example' => '1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX'],
'Success' => ['description' => '请求是否成功。取值如下：'."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '重命名数据开发函数',
'changeSet' => [
['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'RenameNode' => [
'summary' => '调用此接口，可以重命名数据开发节点。',
'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' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '652567824470354****'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '希望重命名的名称。', 'type' => 'string', 'required' => true, 'example' => 'Rename'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA81XXXX'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '重命名数据开发节点',
'changeSet' => [
['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'RenameResource' => [
'summary' => '调用此接口，可以对数据开发文件资源进行重命名。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发文件资源唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '543217824470354****'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '希望重命名的名称。', 'type' => 'string', 'required' => true, 'example' => 'Rename'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID：用于定位日志、排查问题', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX'],
'Success' => ['description' => '请求是否成功。取值如下：'."\n"
."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '重命名数据开发文件资源',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'RenameWorkflowDefinition' => [
'summary' => '调用此接口，可以重命名数据开发工作流。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。'."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '数据开发工作流的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '463497880880954****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '希望重命名的名称。', 'type' => 'string', 'required' => true, 'example' => 'Rename'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '975BD43D-C421-595C-A29C-565A8AD5XXXX'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"975BD43D-C421-595C-A29C-565A8AD5XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '重命名数据开发工作流',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'RerunTaskInstances' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244270',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务实例ID列表。',
'type' => 'array',
'items' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
[
'name' => 'UseLatestConfig',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => 'The instance does not exist.', 'description' => '错误信息。'],
],
'description' => '结果信息。',
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '重跑任务实例',
'summary' => '批量重跑多个任务实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]',
],
'RerunWorkflowInstances' => [
'summary' => '重跑工作流实例',
'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' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
'name' => 'EnvType',
'in' => 'formData',
'schema' => [
'description' => '项目环境。'."\n"
."\n"
.'Prod：生产'."\n"
.'Dev：开发',
'type' => 'string',
'required' => false,
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'WorkflowId',
'in' => 'formData',
'schema' => ['description' => '所属工作流的ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '工作流实例的类型。'."\n"
."\n"
.'ManualWorkflow：手动工作流。',
'type' => 'string',
'required' => true,
'example' => 'ManualWorkflow',
'enum' => ['ManualWorkflow'],
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '根据手动工作流名称进行模糊匹配', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'StartTriggerTime',
'in' => 'formData',
'schema' => ['description' => '根据手动工作流实例开始触发时间（创建时间）进行匹配，需要和EndTriggerTime配合使用', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'EndTriggerTime',
'in' => 'formData',
'schema' => ['description' => '根据手动工作流实例结束触发时间（创建时间）进行匹配，需要和StartTriggerTime配合使用', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'Bizdate',
'in' => 'formData',
'schema' => ['description' => '根据手动工作流实例运行指定的业务时间进行匹配', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '根据手动工作流实例运行的状态进行匹配',
'type' => 'string',
'required' => false,
'example' => 'Failure',
'enum' => ['Success', 'Failure'],
],
],
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '根据手动工作流实例ID列表进行匹配',
'type' => 'array',
'items' => ['description' => '手动工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
'required' => false,
],
],
[
'name' => 'Filter',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '设置手动工作流实例的内部实例的匹配条件',
'type' => 'object',
'properties' => [
'RerunDownstreamEnabled' => ['description' => '是否重跑符合条件的实例以及所有下游', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'TaskIds' => [
'description' => '根据手动工作流内部任务的taskId进行匹配',
'type' => 'array',
'items' => ['description' => '内容任务的taskId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
'required' => false,
],
'TaskName' => ['description' => '根据手动工作流内部任务的名称进行匹配', 'type' => 'string', 'required' => false, 'example' => 'test'],
'TaskInstanceStatuses' => [
'description' => '根据手动工作流实例的内部实例的运行状态进行匹配',
'type' => 'array',
'items' => [
'description' => '内部实例的运行状态',
'type' => 'string',
'required' => false,
'example' => 'Failure',
'enum' => ['NotRun', 'Failure', 'Success'],
],
'required' => false,
],
'TaskTypes' => [
'description' => '根据手动工作流内部任务的类型进行匹配',
'type' => 'array',
'items' => ['description' => '内部任务的类型。各节点的TaskType取值，请参见DataWorks节点合集。', 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL'."\n"],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'OperationId' => ['description' => '操作ID。您可以凭借此字段通过GetRerunWorkflowInstancesResult接口来查询创建操作的结果。', 'type' => 'string', 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n"],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '重跑工作流实例',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\\\n\\"\\n}","type":"json"}]',
],
'ResumeTaskInstances' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '244302',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务实例ID列表。',
'type' => 'array',
'items' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => 'The instance does not exist.'."\n", 'description' => '错误信息。'],
],
'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' => '恢复任务实例',
'summary' => '批量恢复多个已暂停的任务实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'RevokeMemberProjectRoles' => [
'summary' => '撤销工作空间成员的角色。',
'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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '105149'],
],
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => 'Dataworks账号 ID。您可以登录[ DataWorks 控制台——管理中心](https://dataworks.console.aliyun.com/product/ms_menu)，选择需要操作的工作空间进入管理中心页面，进入租户成员与角色页面，查看需要移除角色的账号 ID。', 'type' => 'string', 'required' => true, 'example' => '123422344899'."\n"],
],
[
'name' => 'RoleCodes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作空间角色 Code 列表。 您可以调用 [ListProjectRoles](~~2853930~~) 获取角色的 Code。 '."\n"
."\n"
.'该参数用来描述本次 API 调用操作将要撤销的工作空间角色 。',
'type' => 'array',
'items' => ['description' => '工作空间角色 Code 。', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest'],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', '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' => '撤销空间成员的空间角色',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:RevokeMemberProjectRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'RollbackParameter' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'RollbackVersion',
'in' => 'formData',
'schema' => ['description' => '回滚版本。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '回滚参数',
'summary' => '回滚指定参数。',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'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' => '任务实例ID列表。',
'type' => 'array',
'items' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => 'The instance does not exist.', 'description' => '错误信息。'],
],
'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' => '置成功任务实例',
'summary' => '批量置成功多个任务实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'StartDIJob' => [
'summary' => '启动数据集成新版任务。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '235100',
'abilityTreeNodes' => ['FEATUREdideBP0OJZ'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '实例 ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'ForceToRerun',
'in' => 'query',
'schema' => ['description' => '是否强制重跑全部同步步骤。不填默认为不强制重跑。'."\n"
."\n"
.'- 不强制重跑，只会从未运行的步骤开始启动，已经运行过的步骤不会再运行。'."\n"
.'- 强制重跑，整个任务步骤全部重新运行', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'RealtimeStartSettings',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '实时同步启动设置'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "StartTime":1663765058'."\n"
.'}'."\n"
.'```',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '起始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1671516776'],
'FailoverSettings' => [
'description' => '该字段已废弃，请在创建任务时使用高级参数进行Failover设置',
'type' => 'object',
'properties' => [
'Interval' => ['description' => '该字段已废弃，请在创建任务时使用高级参数进行Failover设置', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '10'],
'UpperLimit' => ['description' => '该字段已废弃，请在创建任务时使用高级参数进行Failover设置', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '30'],
],
'deprecated' => true,
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '10000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['description' => '请求是否成功。取值如下：'."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', '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' => '启动数据集成同步任务',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'StartWorkflowInstances' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '260768',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
],
'parameters' => [
[
'name' => 'Ids',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '工作流实例ID列表。',
'type' => 'array',
'items' => ['description' => '工作流实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => true,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以工作流实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => '该实例不存在。', 'description' => '错误信息。'],
],
'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' => '启动工作流实例',
'summary' => '批量启动多个工作流实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'StopDIJob' => [
'summary' => '中止数据集成任务。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '235119',
'abilityTreeNodes' => ['FEATUREdideBP0OJZ'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '同步任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11668'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11668'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['description' => '请求是否成功。取值如下：'."\n"
."\n"
.'- True：成功。'."\n"
.'- False：失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。', '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' => '停止数据集成同步任务',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'StopProcessInstance' => [
'summary' => '用于撤回或终止指定的审批流程实例。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '243667',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProcessInstanceId',
'in' => 'formData',
'schema' => ['description' => '流程实例ID，支持新、老安全中心的审批单'."\n", 'type' => 'string', 'required' => true, 'example' => '176906667488145'],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等串，建议使用UUID。', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '撤回审批流程实例',
'description' => '## 请求说明'."\n"
.'- 该接口允许申请人撤回自己发起的审批流程。'."\n"
.'- 只有流程的发起者才能调用此接口进行撤回操作。'."\n"
.'- 调用成功后，审批流程将被终止，并且状态会更新为已撤回。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\"\\n}","type":"json"}]',
],
'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' => '任务实例ID列表。',
'type' => 'array',
'items' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => 'The instance does not exist.', 'description' => '错误信息。'],
],
'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' => '终止任务实例',
'summary' => '批量终止多个任务实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '工作流实例ID列表。',
'type' => 'array',
'items' => ['description' => '工作流实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => true,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以工作流实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => 'The instance does not exist.', 'description' => '错误信息。'],
],
'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' => '终止工作流实例',
'summary' => '批量终止多个工作流实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => ['description' => '文件的ID，'."\n"
.'您可以通过[ListFiles](~~173942~~)查询对应文件的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '提交的说明信息。', 'type' => 'string', 'required' => false, 'example' => 'Submit a task for the first time'],
],
[
'name' => 'SkipAllDeployFileExtensions',
'in' => 'formData',
'schema' => ['description' => '文件提交成功后是否跳过发布前检查：'."\n"
."\n"
.'- false：不跳过。文件提交后会自动触发发布前检查流程，检查通过后才会进入可发布状态。'."\n"
.'- true：跳过。文件提交后不会触发发布前检查流程，可直接进入发布流程。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => ['description' => '发布包的ID。后续需要将该ID作为参数调用[GetDeployment](~~173950~~)接口，获取本次发布的具体情况。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'The connection does not exist.'],
'Success' => ['description' => '调用是否成功。'."\n"
."\n"
.'- true：成功。'."\n"
.'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]',
'title' => '提交文件至调度系统开发环境',
'summary' => '提交文件至调度系统的开发环境，生成对应的任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '任务实例ID列表。',
'type' => 'array',
'items' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'."\n"],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => 'The instance does not exist.', 'description' => '错误信息。'],
],
'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' => '暂停任务实例',
'summary' => '批量暂停多个任务实例。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'TagDataAssets' => [
'summary' => '为资产绑定标签。',
'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' => '待绑定的数据资产标签列表',
'type' => 'array',
'items' => [
'description' => '标签K:V结构定义。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$'],
'Value' => ['description' => '标签值。', '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' => '数据资产唯一id列表。',
'type' => 'array',
'items' => ['description' => '数据资产唯一id。', 'type' => 'string', 'required' => true, 'example' => '7259557000'],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'DataAssetType',
'in' => 'query',
'schema' => [
'description' => '数据资产类型'."\n"
."\n"
.'- 数据表（ACS::DataWorks::Table）'."\n"
."\n"
.'- 调度任务（ACS::DataWorks::Task）',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'ACS::DataWorks::Task',
'enum' => ['ACS::DataWorks::Task', 'ACS::DataWorks::Table'],
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => [
'description' => '数据资产所属的工作空间环境，包括：'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'enum' => ['Dev', 'Prod'],
],
],
[
'name' => 'AutoTraceEnabled',
'in' => 'query',
'schema' => ['description' => '是否开启血缘自动回溯。', 'type' => 'boolean', 'required' => false, 'example' => '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' => '0bc1ec92159376'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '绑定数据资产标签',
'description' => '需要购买DataWorks企业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'TestDataSourceConnectivity' => [
'summary' => '测试数据源在资源组上的连通性。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '250948',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['title' => '资源组ID，即资源组的唯一标识符。', 'description' => '资源组ID，即资源组的唯一标识符。', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
[
'name' => 'DataSourceId',
'in' => 'query',
'schema' => ['title' => '待测试连通性的数据源ID，数据源ID是数据源的唯一标识符。', 'description' => '待测试连通性的数据源ID，数据源ID是数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '144544'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['title' => 'DataWorks项目空间ID。', 'description' => 'DataWorks项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID，一次请求的唯一标识。'."\n", 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA81****'],
'Connectivity' => [
'description' => '连通性详情',
'type' => 'object',
'properties' => [
'ConnectState' => ['title' => '测试后的连通性状态。'."\n"
.'枚举值：'."\n"
.'● Connectable：可连通'."\n"
.'● ConfigError：网络可通，但是配置有误'."\n"
.'● Unreachable：不可连通'."\n"
.'● Unsupport：其他不支持的场景，例如资源组处于初始化中', 'description' => '测试后的连通性状态。'."\n"
.'枚举值：'."\n"
.'● Connectable：可连通'."\n"
.'● ConfigError：网络可通，但是配置有误'."\n"
.'● Unreachable：不可连通'."\n"
.'● Unsupport：其他不支持的场景，例如资源组处于初始化中', 'type' => 'string', 'example' => 'Connectable'],
'ConnectMessage' => ['title' => '连通性测试失败时，具体的描述信息。'."\n"
.'连通性测试成功时，无该信息。', 'description' => '连通性测试失败时，具体的描述信息。'."\n"
.'连通性测试成功时，无该信息。', 'type' => 'string', 'example' => '连接数据库失败'],
'DetailLogs' => [
'description' => '测试连通性各个阶段的详细日志',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '表示该步骤的起始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1730217600001'],
'EndTime' => ['description' => '表示该步骤的终止时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1730217604002'],
'Code' => ['description' => '测试项代码', 'type' => 'string', 'example' => 'validate_input_parameters'],
'Message' => ['description' => '测试步骤名称', 'type' => 'string', 'example' => 'Validate input parameters'],
],
'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\\": \\"Validate input parameters\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '测试数据源的连通性',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'租户所有者、空间管理员、部署、开发、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:TestDataSourceConnectivity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'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' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod(生产)'."\n"
.'- Dev(开发)',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'TriggerTime',
'in' => 'formData',
'schema' => ['description' => '定时触发时间。格式为时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710239005403'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'Success' => ['description' => '操作是否成功。', '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' => '触发调度任务实例',
'summary' => '在某个定时时间，触发指定HTTP触发器调度任务运行。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'UnTagDataAssets' => [
'summary' => '为数据资产解绑标签关系。',
'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' => '待解绑的标签列表。',
'type' => 'array',
'items' => [
'description' => '标签K:V结构定义。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key', 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$'],
'Value' => ['description' => '标签值。', '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' => '数据资产唯一id列表。',
'type' => 'array',
'items' => ['description' => '数据资产唯一id。', 'type' => 'string', 'required' => true, 'example' => '7259557000'],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'DataAssetType',
'in' => 'query',
'schema' => [
'description' => '数据资产类型'."\n"
."\n"
.'- 数据表（ACS::DataWorks::Table）'."\n"
."\n"
.'- 调度任务（ACS::DataWorks::Task）',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'ACS::DataWorks::Task',
'enum' => ['ACS::DataWorks::Task', 'ACS::DataWorks::Table'],
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => '工作空间的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
[
'name' => 'EnvType',
'in' => 'query',
'schema' => [
'description' => '数据资产所属的工作空间环境，包括'."\n"
."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
],
'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' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '解绑数据资产标签',
'description' => '需要购买DataWorks企业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateAlertRule' => [
'summary' => '更新自定义监控告警规则。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '249192',
'abilityTreeNodes' => ['FEATUREdideRJGWWC'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => '自定义规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '105412'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义规则名。', 'type' => 'string', 'required' => false, 'example' => 'collection_name'],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => '自定义规则的责任人阿里云UID。', 'type' => 'string', 'required' => false, 'example' => '193379****'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '告警规则是否启用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'TriggerCondition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '触发告警的条件。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '触发告警的类型，枚举值：'."\n"
."\n"
.'- Finished: 实例完成'."\n"
.'- UnFinished: 实例未完成'."\n"
.'- Error: 实例出错'."\n"
.'- CycleUnfinished: 实例周期未完成'."\n"
.'- Timeout: 实例超时'."\n"
.'- InstanceTransferComplete: 任务转实例完成'."\n"
.'- InstanceTransferFluctuate: 实例数量波动'."\n"
.'- ExhaustedError: 自动重跑后仍出错'."\n"
.'- InstanceKeyword: 出错实例包含关键词'."\n"
.'- InstanceErrorCount: 出错实例数量'."\n"
.'- InstanceErrorPercentage: 出错实例占比'."\n"
.'- ResourceGroupPercentage: 资源组利用率'."\n"
.'- ResourceGroupWaitCount: 资源组等资源实例数', 'type' => 'string', 'required' => false, 'example' => 'ERROR'],
'Extension' => [
'description' => '扩展信息，部分触发条件需要配置。',
'type' => 'object',
'properties' => [
'Error' => [
'description' => '出错告警配置。',
'type' => 'object',
'properties' => [
'StreamTaskIds' => [
'description' => '实时计算任务监控时填入对应的任务ID。',
'type' => 'array',
'items' => ['description' => '实时计算任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123123'],
'required' => false,
],
'AutoRerunAlertEnabled' => ['description' => '离线任务由于失败自动重跑，是否产生告警。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
'Timeout' => [
'description' => '超时告警配置。',
'type' => 'object',
'properties' => [
'TimeoutInMinutes' => ['description' => '超时时间，单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
'UnFinished' => [
'description' => '未完成告警配置。',
'type' => 'object',
'properties' => [
'UnFinishedTime' => ['description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'required' => false, 'example' => '12:00'],
],
'required' => false,
],
'CycleUnfinished' => [
'description' => '周期未完成告警配置。',
'type' => 'object',
'properties' => [
'CycleAndTime' => [
'description' => '周期和时间配置列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CycleId' => ['description' => '周期ID，取值范围为[1,288]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'Time' => ['description' => '未完成时间，格式为 hh:mm，hh的取值范围为[0,47]，mm的取值范围为[0,59]。', 'type' => 'string', 'required' => false, 'example' => '01:00'."\n"],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'InstanceErrorCount' => [
'description' => '任务实例出错数量告警配置。',
'type' => 'object',
'properties' => [
'Count' => ['description' => '出错的任务实例数，取值范围为[1,10000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
'InstanceErrorPercentage' => [
'description' => '任务实例出错比例告警配置。',
'type' => 'object',
'properties' => [
'Percentage' => ['description' => '出错实例占比，取值范围 [1-100]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
'InstanceTransferFluctuate' => [
'description' => '转实例数量波动告警配置。',
'type' => 'object',
'properties' => [
'Trend' => ['description' => '转实例波动类型，枚举值：'."\n"
."\n"
.'- abs: 绝对值'."\n"
.'- increase: 增长'."\n"
.'- decrease: 下降', 'type' => 'string', 'required' => false, 'example' => 'abs'],
'Percentage' => ['description' => '转实例波动百分比，取值范围[1-100]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
'required' => false,
],
],
'required' => false,
],
'Target' => [
'description' => '监控对象。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型，枚举值：'."\n"
."\n"
.'- Task: 任务节点'."\n"
.'- Baseline: 基线'."\n"
.'- Project: 工作空间'."\n"
.'- BizProcess: 业务流程', 'type' => 'string', 'required' => false, 'example' => 'Task'],
'Ids' => [
'description' => '监控对象ID列表。',
'type' => 'array',
'items' => ['description' => '监控对象ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1894580'],
'required' => false,
],
'AllowTasks' => [
'description' => '监控任务白名单列表。',
'type' => 'array',
'items' => ['description' => '监控任务白名单ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1111'],
'required' => false,
],
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'Notification',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警通知配置。',
'type' => 'object',
'properties' => [
'SilenceStartTime' => ['description' => '静默开始时间，格式为 HH:mm:ss 。', 'type' => 'string', 'required' => false, 'example' => '00:00:00'."\n"],
'SilenceEndTime' => ['description' => '静默结束时间，格式为 HH:mm:ss 。', 'type' => 'string', 'required' => false, 'example' => '00:00:00'."\n"],
'IntervalInMinutes' => ['description' => '告警间隔，单位为分钟，取值范围[5,10000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
'Maximum' => ['description' => '一个自然日内的告警最大次数，取值范围[1, 10000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'Channels' => [
'description' => '告警通道列表。',
'type' => 'array',
'items' => ['description' => '告警通道，枚举值：'."\n"
."\n"
.'- Mail: 邮件'."\n"
.'- Phone: 电话'."\n"
.'- Sms: 短信'."\n"
.'- Dingding: 钉钉webhook'."\n"
.'- Feishu: 飞书webhook'."\n"
.'- Weixin: 企业微信webhook'."\n"
.'- Webhook: 自定义Webhook', 'type' => 'string', 'required' => false, 'example' => 'Sms'],
'required' => false,
],
'Receivers' => [
'description' => '告警接收对象。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '告警接收对象类型，枚举值：'."\n"
."\n"
.'- AliUid: 阿里云UID'."\n"
.'- ShiftSchedule: 值班表'."\n"
.'- TaskOwner: 任务责任人，适用于自定义告警和事件告警'."\n"
.'- Owner: 责任人，适用于基线告警'."\n"
.'- WebhookUrl: 自定义webhookUrl'."\n"
.'- DingdingUrl: 钉钉webhookUrl'."\n"
.'- FeishuUrl: 飞书webhookUrl'."\n"
.'- WeixinUrl: 企业微信webhookUrl', 'type' => 'string', 'required' => false, 'example' => 'TaskOwner'],
'ReceiverValues' => [
'description' => '告警接收对象值。',
'type' => 'array',
'items' => ['description' => '告警接收对象值。当 ReceiverType 为 AliUid 时填阿里云UID，为 ShiftSchedule 时填值班表ID，为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', 'type' => 'string', 'required' => false, 'example' => '123123'],
'required' => false,
],
'Extension' => ['description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 {"atAll":true} @所有人。', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n"],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的ID。用于定位日志，排查问题。'."\n"
."\n", 'type' => 'string', 'example' => 'D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC'],
'Success' => ['description' => '调用是否成功。'."\n"
."\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' => '更新自定义监控告警规则',
'changeSet' => [
['createdAt' => '2024-12-27T03:06:33.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。您可以[登录DataWorks管控台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间配置页面获取工作空间ID。该参数与`ProjectIdentifier`参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10001'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。您可以登录[DataWorks控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间配置页面获取工作空间名称。该参数与`ProjectId`参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'project_dw'],
],
[
'name' => 'BusinessName',
'in' => 'formData',
'schema' => ['description' => '业务流程的名称。'."\n"
."\n"
.'您可以调用[ListBusiness](~~173945~~)接口获取。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'firstBusiness'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '业务流程的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'modified from first business'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '业务流程的责任人。'."\n"
."\n"
.'您可以调用[ListBusiness](~~173945~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '34842****'],
],
[
'name' => 'BusinessId',
'in' => 'formData',
'schema' => ['description' => '业务流程的ID。'."\n"
."\n"
.'您可以调用[ListBusiness](~~173945~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '300001'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '请求是否成功：'."\n"
."\n"
.'- true: 成功。'."\n"
.'- false: 失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'title' => '更新业务流程',
'summary' => '该接口用于更新业务流程。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateColumnBusinessMetadata' => [
'summary' => '更新数据地图数据表给定字段的业务元数据，当前仅支持更新字段的业务描述和自定义属性。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268008',
'abilityTreeNodes' => ['FEATUREdideE9XYA6'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => 'ID', 'description' => '字段ID，可参考ListColumns接口返回结果，'."\n"
.'以及[元数据实体相关概念说明](~~2880092~~)。', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '字段业务描述。不传Description且不传CustomAttributes时，仅传Id会兼容旧行为清空字段业务描述；如果只更新自定义属性且不希望影响字段业务描述，请传CustomAttributes', 'description' => '字段业务描述。', 'type' => 'string', 'required' => false, 'example' => 'test description'],
],
[
'name' => 'CustomAttributes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '自定义属性值，key为自定义属性标识，value最多一个值；空列表表示删除该属性值。不传Description时传入本参数可避免清空字段业务描述；传空对象表示不更新自定义属性',
'description' => '自定义属性值，key为自定义属性标识，value最多一个值；空列表表示删除该属性值。不传Description时传入本参数可避免清空字段业务描述；传空对象表示不更新自定义属性',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'title' => '自定义属性值的数组，当前仅支持单值数组',
'description' => '自定义属性值的数组，当前仅支持单值数组',
'type' => 'array',
'items' => ['title' => '自定义属性值', 'type' => 'string', 'example' => '张三', 'description' => '属性值'],
],
'example' => '{"biz_owner":["张三"]}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新数据地图数据表字段的业务元数据',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 仅maxcompute, hms, dlf 类型支持',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateComponent' => [
'summary' => '更新组件。',
'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' => '组件ID。', 'type' => 'string', 'required' => true, 'example' => '568780096083*******'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "kind": "Component",'."\n"
.' "version": "1.1.2",'."\n"
.' "spec": {'."\n"
.' "components": ['."\n"
.' {'."\n"
.' "id": "568780096083*******",'."\n"
.' "script": {'."\n"
.' "content": "select \'@@{para1}\', \'@@{para2}\'"'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc1ec92159376'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新组件',
'description' => '本接口当前处于试用阶段。需要体验的用户可以提出申请，管理员加入试用名单后即可调用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateComputeResource' => [
'summary' => '根据计算资源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' => '计算资源Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['title' => 'Dataworks项目空间Id', 'description' => 'Dataworks项目空间Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'ConnectionPropertiesMode',
'in' => 'query',
'schema' => [
'title' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式',
'description' => '计算资源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式',
'type' => 'string',
'required' => false,
'example' => 'InstanceMode',
'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'],
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '数据源描述信息，长度不超过 3000 个字符', 'description' => '计算资源描述信息，长度不超过 3000 个字符', 'type' => 'string', 'required' => false, 'example' => 'Level description'],
],
[
'name' => 'ConnectionProperties',
'in' => 'query',
'schema' => ['title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', 'description' => '计算资源具体连接配置信息，包括连接地址、访问身份、环境信息等。计算资源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', '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' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'],
'Success' => [
'description' => '计算资源是否修改成功：'."\n"
.'- true：是'."\n"
.'- false：否',
'type' => 'boolean',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改计算资源',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'3. 租户所有者、租户管理员、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:UpdateComputeResource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateCustomAttribute' => [
'summary' => '更新自定义属性定义。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => '自定义属性ID，需匹配 `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`，custom-attribute: 后面的部分长度小于100', 'description' => '自定义属性的ID', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['title' => '新的自定义属性展示名称，长度小于128个字符', 'description' => '新的自定义属性展示名称，长度小于128个字符', 'type' => 'string', 'required' => false, 'example' => '业务负责人'],
],
[
'name' => 'EntityTypes',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'title' => '适用实体类型列表，支持精确实体类型以及 `*-table`、`*-column` 通配写法',
'description' => '适用实体类型列表，支持精确实体类型以及 `*-table`、`*-column` 通配写法，如'."\n"
.'- dataworks-project 工作空间'."\n"
.'- dataworks-dataset dataworks数据集'."\n"
.'- maxcompute-table maxcompute表'."\n"
.'- *-column 所有字段类型',
'type' => 'array',
'items' => ['description' => '适用实体类型', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table'],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
[
'name' => 'ValueEnums',
'in' => 'formData',
'style' => 'simple',
'schema' => [
'title' => '枚举可选值，仅ENUM类型支持；更新时仅支持追加枚举值',
'description' => '枚举可选值，仅ENUM类型支持；更新时仅支持追加枚举值',
'type' => 'array',
'items' => ['description' => '枚举可选值', 'type' => 'string', 'required' => false, 'example' => 'VALUE_1'],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'DisplayEnabled',
'in' => 'formData',
'schema' => ['title' => '是否在页面展示', 'description' => '是否在页面展示', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SearchFilterEnabled',
'in' => 'formData',
'schema' => ['title' => '是否支持作为筛选条件', 'description' => '是否支持作为筛选条件', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '新的自定义属性描述，长度小于256个字符', 'description' => '新的自定义属性描述，长度小于256个字符', 'type' => 'string', 'required' => false, 'example' => 'test comment'],
],
],
'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' => '6B56C4A2-C7F3-52AF-8417-6DFF7447011B'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'Result' => ['title' => '更新结果', 'description' => '更新结果', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新自定义属性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B56C4A2-C7F3-52AF-8417-6DFF7447011B\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]',
],
'UpdateDIAlarmRule' => [
'summary' => '更新数据集成报警规则。',
'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' => '告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '34982'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '告警规则描述。', 'type' => 'string', 'required' => false, 'example' => 'Alert rule description.'],
],
[
'name' => 'MetricType',
'in' => 'query',
'schema' => ['description' => '告警指标类型，可选的枚举值：'."\n"
.'- Heartbeat（任务状态报警）'."\n"
.'- FailoverCount（failover次数报警）'."\n"
.'- Delay（任务延迟报警）'."\n"
.'- DdlReport: DDL通知'."\n"
.'- ResourceUtilization： 资源组使用率', 'type' => 'string', 'required' => false, 'example' => 'Heartbeat'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => ['description' => '告警规则是否启用，默认不开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '1'],
],
[
'name' => 'TriggerConditions',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警触发条件列表，支持多条件。',
'type' => 'array',
'items' => [
'description' => '告警触发条件列表，支持多条件。',
'type' => 'object',
'properties' => [
'Severity' => ['description' => '严重程度，可选的枚举值;'."\n"
.'- Warning'."\n"
.'- Critical', 'type' => 'string', 'required' => false, 'example' => 'Warning'],
'Duration' => ['description' => '告警计算时间区间，单位分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15'],
'Threshold' => ['description' => '告警阈值。'."\n"
."\n"
.'- 任务状态报警：无需填写阈值。'."\n"
.'- failover次数报警：阈值为failover次数。'."\n"
.'- 任务延迟报警：阈值为延迟时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
'DdlTypes' => [
'description' => '在DDL通知的时候才生效，需要生效的DDL列表。',
'type' => 'array',
'items' => ['description' => '在MetricType配置为DdlReport时才返回需要生效的DDL列表，包括 '."\n"
.'- AlterAddColumn 加列'."\n"
.' - AlterDropColumn 删列'."\n"
.' - AlterRenameColumn 修改列名'."\n"
.' - AlterRenameTable 修改表名'."\n"
.' - AlterTableModify 其他修改表'."\n"
.' - DropTable 删除表'."\n"
.' - TruncateTable 清空表', 'type' => 'string', 'required' => false, 'example' => 'AlterAddColumn'],
'required' => false,
],
'DdlReportTags' => [
'description' => '该字段已废弃，请使用DdlTypes字段。',
'type' => 'array',
'items' => ['description' => '该字段已废弃，请使用DdlTypes字段。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'AlterAddColumn'],
'deprecated' => true,
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'NotificationSettings',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警通知设置。',
'type' => 'object',
'properties' => [
'NotificationChannels' => [
'description' => '告警通知渠道。',
'type' => 'array',
'items' => [
'description' => '告警通知渠道。',
'type' => 'object',
'properties' => [
'Severity' => ['description' => '严重程度，可选的枚举值：'."\n"
.'- Warning'."\n"
.'- Critical', 'type' => 'string', 'required' => false, 'example' => 'Warning'],
'Channels' => [
'description' => '通道，可选的枚举值：'."\n"
.'- Mail（邮件）'."\n"
.'- Phone（电话）'."\n"
.'- Sms（短信）'."\n"
.'- Ding（钉钉）',
'type' => 'array',
'items' => ['description' => '通道，可选的枚举值：'."\n"
.'- Mail（邮件）'."\n"
.'- Phone（电话）'."\n"
.'- Sms（短信）'."\n"
.'- Ding（钉钉）', 'type' => 'string', 'required' => false, 'example' => 'Ding'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'NotificationReceivers' => [
'description' => '告警通知接收方。',
'type' => 'array',
'items' => [
'description' => '告警通知接收方。',
'type' => 'object',
'properties' => [
'ReceiverType' => ['description' => '接收方类型，取值范围：AliyunUid/DingToken/FeishuToken/WebHookUrl', 'type' => 'string', 'required' => false, 'example' => 'DingToken'],
'ReceiverValues' => [
'description' => '接收方取值。'."\n"
."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。',
'type' => 'array',
'items' => ['description' => '接收方取值。'."\n"
."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为钉钉token时，接收方取值为具体钉钉token值。', 'type' => 'string', 'required' => false, 'example' => 'token1'],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
'MuteInterval' => ['description' => '告警抑制间隔时长，单位分钟，默认5分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
'InhibitionInterval' => ['description' => '该字段已废弃，请使用MuteInterval进行配置。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '5'],
],
'required' => false,
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '告警规则的名称。', 'type' => 'string', 'required' => false, 'example' => 'alarm_rule_name'],
],
[
'name' => 'DIAlarmRuleId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '34982'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '资源ID，如ECS实例的创建接口CreateInstance应返回InstanceId。', 'description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败，您可以根据请求ID定位具体问题。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新数据集成同步任务告警规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T07:20:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateDIJob' => [
'summary' => '更新数据集成任务。',
'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' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11588'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '任务的描述', 'type' => 'string', 'required' => false, 'example' => 'DI Job Demo'],
],
[
'name' => 'TableMappings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表'."\n"
."\n\n"
.'> [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]',
'type' => 'array',
'items' => [
'description' => '同步对象转换映射列表，列表中每个元素描述了一组源端同步对象选择规则列表和在该组同步对象上应用的同步对象转换规则列表',
'type' => 'object',
'properties' => [
'SourceObjectSelectionRules' => [
'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表',
'type' => 'array',
'items' => [
'description' => '每条规则可选择待同步源端对象的不同对象类型，如选择源端数据库、源端数据表',
'type' => 'object',
'properties' => [
'Action' => ['description' => '选择动作，取值范围：Include/Exclude', 'type' => 'string', 'required' => false, 'example' => 'Include'],
'Expression' => ['description' => '表达式', 'type' => 'string', 'required' => false, 'example' => 'mysql_table_1'],
'ExpressionType' => ['description' => '表达式类型，取值范围：Exact/Regex', 'type' => 'string', 'required' => false, 'example' => 'Exact'],
'ObjectType' => ['description' => '对象类型，可选的枚举值：'."\n"
."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'required' => false, 'example' => 'Table'],
],
'required' => false,
],
'required' => false,
],
'TransformationRules' => [
'description' => '源端对象上应用的转换规则',
'type' => 'array',
'items' => [
'description' => '源端对象上应用的转换规则',
'type' => 'object',
'properties' => [
'RuleName' => ['description' => '规则名称，在一种动作类型+动作作用的目标类型下规则名称唯一，长度不能超过50个字符', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1'],
'RuleActionType' => ['description' => '动作类型，可选的枚举值：'."\n"
."\n"
.'- DefinePrimaryKey（定义主键）'."\n"
.'- Rename（重命名）'."\n"
.'- AddColumn（增加列）'."\n"
.'- HandleDml（DML处理）', 'type' => 'string', 'required' => false, 'example' => 'Rename'],
'RuleTargetType' => ['description' => '动作作用的目标类型，可选的枚举值：'."\n"
."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'required' => false, 'example' => 'Table'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'JobSettings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '同步任务维度的设置，含DDL处理策略、源端和目标端列数据类型映射策略、任务运行时参数等',
'type' => 'object',
'properties' => [
'ChannelSettings' => ['description' => '通道相关任务设置，可以对一些特定通道进行特殊配置，目前支持Holo2Holo（从holo同步到holo），Holo2Kafka（从Holo同步到Kafka）'."\n"
."\n"
.'1. Holo2Kafka'."\n"
.'- 示例：{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}'."\n"
.'kafkaClientProperties：kafka producer参数，写入kafka时使用'."\n"
.'- keyColumns， 需要写入的kafka列取值'."\n"
.'- writeMode，kafka写入格式，目前支持json/canal'."\n"
.'2. Holo2Holo'."\n"
.'- 示例： {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n"
."\n"
.'- conflictMode: 写入holo冲突处理策略，replace-覆盖、ignore-忽略'."\n"
."\n"
.'- writeMode: 写入holo方式，replay-重放、insert-插入'."\n"
."\n"
.'- dynamicColumnAction：写入holo 动态列方式replay-重放、insert-插入，ignore-忽略', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "structInfo": "MANAGED",'."\n"
.' "storageType": "TEXTFILE",'."\n"
.' "writeMode": "APPEND",'."\n"
.' "partitionColumns": ['."\n"
.' {'."\n"
.' "columnName": "pt",'."\n"
.' "columnType": "STRING",'."\n"
.' "comment": ""'."\n"
.' }'."\n"
.' ],'."\n"
.' "fieldDelimiter": ""'."\n"
.'}'],
'ColumnDataTypeSettings' => [
'description' => '列类型映射数组'."\n"
."\n"
.'> ["ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]',
'type' => 'array',
'items' => [
'description' => '单条列类型映射',
'type' => 'object',
'properties' => [
'DestinationDataType' => ['description' => '目标端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', 'type' => 'string', 'required' => false, 'example' => 'text'],
'SourceDataType' => ['description' => '源端类型。如bigint，boolean，string，text，datetime，timestamp，decimal，binary，不同数据源类型会有类型差异', 'type' => 'string', 'required' => false, 'example' => 'bigint'],
],
'required' => false,
],
'required' => false,
],
'CycleScheduleSettings' => [
'description' => '周期调度设置',
'type' => 'object',
'properties' => [
'ScheduleParameters' => ['description' => '调度参数', 'type' => 'string', 'required' => false, 'example' => 'bizdate=$bizdate'."\n"],
],
'required' => false,
],
'DdlHandlingSettings' => [
'description' => 'DDL处理设置数组。'."\n"
."\n\n"
.'> ["DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]',
'type' => 'array',
'items' => [
'description' => '单条DDL处理设置',
'type' => 'object',
'properties' => [
'Action' => ['description' => '处理动作，可选的枚举值：'."\n"
."\n"
.'- Ignore（忽略）'."\n"
.'- Critical（报错）'."\n"
.'- Normal（正常处理）', 'type' => 'string', 'required' => false, 'example' => 'Critical'],
'Type' => ['description' => 'DDL类型，可选的枚举值：'."\n"
."\n"
.'- RenameColumn（重命名列）'."\n"
.'- ModifyColumn（更新列）'."\n"
.'- CreateTable（新建表）'."\n"
.'- TruncateTable（清空表）'."\n"
.'- DropTable（删除表）'."\n"
.'- DropColumn（删除列）'."\n"
.'- AddColumn（新增列）', 'type' => 'string', 'required' => false, 'example' => 'AddColumn'],
],
'required' => false,
],
'required' => false,
],
'RuntimeSettings' => [
'description' => '运行时设置',
'type' => 'array',
'items' => [
'description' => '运行时设置',
'type' => 'object',
'properties' => [
'Name' => ['description' => '设置名称，可选的枚举值：'."\n"
."\n"
.'- src.offline.datasource.max.connection（离线批量任务源端最大连接数）'."\n"
.'- dst.offline.truncate (是否清空目标表）'."\n"
.'- runtime.offline.speed.limit.enable（离线批量任务是否开启限流）'."\n"
.'- runtime.offline.concurrent（离线批量同步任务并发度）'."\n"
.'- runtime.enable.auto.create.schema（是否自动在目标端创建schema）'."\n"
.'- runtime.realtime.concurrent（实时任务并发度）'."\n"
.'- runtime.realtime.failover.minute.dataxcdc (failover失败重启等待时间单位分钟)'."\n"
.'- runtime.realtime.failover.times.dataxcdc (failover失败重启次数）', 'type' => 'string', 'required' => false, 'example' => 'src.offline.datasource.max.connection'],
'Value' => ['description' => '设置取值', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'ResourceSettings',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '资源设置',
'type' => 'object',
'properties' => [
'OfflineResourceSettings' => [
'description' => '离线同步资源',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '离线同步使用的数据集成资源组cu', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
'ResourceGroupIdentifier' => ['description' => '离线同步使用的数据集成资源组名称', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222'],
],
'required' => false,
],
'RealtimeResourceSettings' => [
'description' => '实时同步资源',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '实时同步使用的数据集成资源组cu', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
'ResourceGroupIdentifier' => ['description' => '实时同步使用的数据集成资源组名称', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222'],
],
'required' => false,
],
'ScheduleResourceSettings' => [
'description' => '调度资源',
'type' => 'object',
'properties' => [
'RequestedCu' => ['description' => '离线同步任务使用的调度资源组cu', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2'],
'ResourceGroupIdentifier' => ['description' => '离线同步任务使用的调度资源组名称', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_222_333'],
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'TransformationRules',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '同步对象转换规则定义列表'."\n"
.'>[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]',
'type' => 'array',
'items' => [
'description' => '单个同步对象转换规则定义，每个元素为一条转换规则定义',
'type' => 'object',
'properties' => [
'RuleActionType' => ['description' => '动作类型，可选的枚举值：'."\n"
."\n"
.'- DefinePrimaryKey（定义主键）'."\n"
.'- Rename（重命名）'."\n"
.'- AddColumn（增加列）'."\n"
.'- HandleDml（DML处理）'."\n"
.'- DefineIncrementalCondition（定义增量条件）'."\n"
.'- DefineCycleScheduleSettings（定义周期调度设置）'."\n"
.'- DefinePartitionKey（定义分区列）', 'type' => 'string', 'required' => false, 'example' => 'Rename'],
'RuleExpression' => ['description' => '规则表达式，json string格式。'."\n"
."\n"
.'1. 重命名规则（Rename）'."\n"
.'- 示例：{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }'."\n"
.'- expression：为重命名转换规则表达式，表达式内支持变量包括：${srcDatasourceName}（源端数据源名）、${srcDatabaseName}（源端库名）、${srcTableName}（源端表名）。'."\n"
.'2. 加列规则（AddColumn)'."\n"
.'- 示例：{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n"
.'- 如不指定，默认规则为不加列不复制。'."\n"
.'- columnName：附加的列名称。'."\n"
.'- columnValueType：附加的列取值类型，包括Constant（常量）、Variable（变量）。'."\n"
.'- columnValue：附加的列取值。当columnValueType=Constant时，value为自定义常量，String类型。当columnValueType=Variable时，value为内置变量。内置变量可选值包括：EXECUTE_TIME（执行时间，Long类型）、DB_NAME_SRC（源端数据库名称，String类型）、DATASOURCE_NAME_SRC（源端数据源名称，String类型）、TABLE_NAME_SRC（源端表名，String类型）、DB_NAME_DEST（目标端数据库名称，String类型）、DATASOURCE_NAME_DEST（目标端数据源名称，String类型）、TABLE_NAME_DEST（目标端表名，String类型）、DB_NAME_SRC_TRANSED（转换后的数据库名称，String类型）。'."\n"
.'3. 指定目标端表的主键列列名（DefinePrimaryKey）'."\n"
.'- 示例：{"columns":["ukcolumn1","ukcolumn2"]}'."\n"
.'- 如不指定默认使用源端主键列。'."\n"
.'- 当目标端为已有表：数据集成系统不会修改目标端表结构，如果指定的主键列不在目标端的列集合中，任务启动会报错提示。'."\n"
.'- 当目标端为自动建表：数据集成系统会自动创建目标端表结构，表结构包含定义的主键列。当指定的主键列不在目标端的列集合中时，任务启动会报错提示。'."\n"
.'4. DML处理规则（HandleDml）'."\n"
.'- 示例： {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\n"
.'- 如不指定，默认规则为Insert、Update、Delete均为Normal'."\n"
.'- dmlType：DML操作类型，Insert（插入）、Update（更新）、Delete（删除）'."\n"
.'- dmlAction：DML处理策略，Normal（正常处理）、Ignore（忽略）、Filter（有条件的正常处理，当dmlType=Update/Delete时使用）、LogicalDelete（逻辑删除）'."\n"
.'- filterCondition：DML过滤条件，当dmlAction=Filter时使用'."\n"
.'5. 增量条件（DefineIncrementalCondition）'."\n"
.'- 示例： {"where":"id > 0"}'."\n"
.'- 指定增量过滤条件'."\n"
.'6. 周期调度参数（DefineCycleScheduleSettings）'."\n"
.'- 示例： {"cronExpress":" * * * * * *", "cycleType":"1"}'."\n"
.'- 指定周期任务调度参数'."\n"
.'7. 指定分区键（DefinePartitionKey）'."\n"
.'- 示例： {"columns":["id"]}'."\n"
.'- 指定分区键', 'type' => 'string', 'required' => false, 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}'],
'RuleName' => ['description' => '规则名称，当动作类型和动作作用的目标类型相同时，规则名称需保证唯一性，长度不能超过50个字符', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1'],
'RuleTargetType' => ['description' => '动作作用的目标类型，可选的枚举值：'."\n"
."\n"
.'- Table（表）'."\n"
.'- Schema（schema）'."\n"
.'- Database（数据库）', 'type' => 'string', 'required' => false, 'example' => 'Table'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间ID。您可以通过[ListProjects](~~178393~~)接口获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'DIJobId',
'in' => 'query',
'schema' => ['description' => '该字段已废弃，请使用Id字段。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11588'],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['title' => '任务责任人', 'description' => '任务责任人', 'type' => 'string', 'required' => false, 'example' => '95279527'],
],
[
'name' => 'FileSpec',
'in' => 'formData',
'schema' => ['description' => '脚本模式代码内容', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "resourceSettings": {'."\n"
.' "realtimeResourceSettings": {'."\n"
.' "requestedCu": 2,'."\n"
.' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n"
.' },'."\n"
.' "offlineResourceSettings": {'."\n"
.' "requestedCu": 2,'."\n"
.' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n"
.' }'."\n"
.' },'."\n"
.' "tableMappings": ['."\n"
.' {'."\n"
.' "sourceObjectSelectionRules": ['."\n"
.' {'."\n"
.' "expression": "autotest_hologres",'."\n"
.' "action": "Include",'."\n"
.' "expressionType": "Exact",'."\n"
.' "objectType": "Datasource"'."\n"
.' },'."\n"
.' {'."\n"
.' "expression": "auto_holo_2661647",'."\n"
.' "action": "Include",'."\n"
.' "expressionType": "Exact",'."\n"
.' "objectType": "Table"'."\n"
.' },'."\n"
.' {'."\n"
.' "expression": "public",'."\n"
.' "action": "Include",'."\n"
.' "expressionType": "Exact",'."\n"
.' "objectType": "Schema"'."\n"
.' }'."\n"
.' ],'."\n"
.' "transformationRules": ['."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "SourceSchema",'."\n"
.' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Schema",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "DefineDstTableSettings",'."\n"
.' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi"'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleActionType": "ColumnMapping",'."\n"
.' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ],'."\n"
.' "sourceDataSourceSettings": ['."\n"
.' {'."\n"
.' "dataSourceProperties": {'."\n"
.' "timeZone": "Asia/Shanghai"'."\n"
.' },'."\n"
.' "dataSourceName": "autotest_hologres"'."\n"
.' }'."\n"
.' ],'."\n"
.' "jobSettings": {'."\n"
.' "runtimeSettings": ['."\n"
."\n"
.' ],'."\n"
.' "ddlHandlingSettings": ['."\n"
."\n"
.' ],'."\n"
.' "columnDataTypeSettings": ['."\n"
."\n"
.' ],'."\n"
.' "cycleScheduleSettings": {'."\n"
."\n"
.' },'."\n"
.' "channelSettings": {'."\n"
.' "destinationChannelSettings": {'."\n"
.' "conflictMode": "replace",'."\n"
.' "dynamicColumnAction": "replay",'."\n"
.' "writeMode": "replay"'."\n"
.' },'."\n"
.' "sourceChannelSettings": {'."\n"
."\n"
.' }'."\n"
.' }'."\n"
.' },'."\n"
.' "destinationDataSourceType": "Hologres",'."\n"
.' "transformationRules": ['."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe",'."\n"
.' "ruleActionType": "SourceSchema",'."\n"
.' "ruleExpression": {'."\n"
.' "columns": ['."\n"
.' {'."\n"
.' "name": "id",'."\n"
.' "category": "normal",'."\n"
.' "type": "BIGINT"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "decimal",'."\n"
.' "category": "normal",'."\n"
.' "type": "DECIMAL"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Schema",'."\n"
.' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleExpression": {'."\n"
.' "expression": "public"'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW",'."\n"
.' "ruleActionType": "Rename",'."\n"
.' "ruleExpression": {'."\n"
.' "expression": "auto_holo_2661647_dst"'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi",'."\n"
.' "ruleActionType": "DefineDstTableSettings",'."\n"
.' "ruleExpression": {'."\n"
.' "ddlString": "BEGIN;'."\n"
.'CREATE TABLE IF NOT EXISTS public.auto_holo_2661647_dst ('."\n"
.' id BIGINT PRIMARY KEY,'."\n"
.' "decimal" DECIMAL(38,18)'."\n"
.');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'time_to_live_in_seconds\', \'3153600000\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'orientation\', \'column\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.level\', \'replica\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.ttl\', \'2592000\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'bitmap_columns\', \'"text","char","varchar"\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'dictionary_encoding_columns\', \'"text":auto,"bytea":auto,"char":auto,"varchar":auto\');'."\n"
.'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'distribution_key\', \'"id"\');'."\n"
.'COMMIT;'."\n"
.'",'."\n"
.' "ddlType": "STRUCT"'."\n"
.' }'."\n"
.' },'."\n"
.' {'."\n"
.' "ruleTargetType": "Table",'."\n"
.' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo",'."\n"
.' "ruleActionType": "ColumnMapping",'."\n"
.' "ruleExpression": {'."\n"
.' "columnMapping": ['."\n"
.' {'."\n"
.' "sourceColName": "id",'."\n"
.' "dstColName": "id"'."\n"
.' },'."\n"
.' {'."\n"
.' "sourceColName": "decimal",'."\n"
.' "dstColName": "decimal"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ],'."\n"
.' "migrationType": "FullAndRealtimeIncremental",'."\n"
.' "destinationDataSourceSettings": ['."\n"
.' {'."\n"
.' "dataSourceProperties": {'."\n"
."\n"
.' },'."\n"
.' "dataSourceName": "autotest_hologres"'."\n"
.' }'."\n"
.' ],'."\n"
.' "sourceDataSourceType": "Hologres"'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\"\\n}","type":"json"}]',
'title' => '更新数据集成同步任务',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-06T05:34:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-11T02:02:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-10-14T09:34:05.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateDataAssetTag' => [
'summary' => '更新标签。',
'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' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key1', 'maxLength' => 128, 'minLength' => 1],
],
[
'name' => 'Values',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签值列表。',
'type' => 'array',
'items' => ['description' => '标签值。', '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' => '标签描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a description.', 'maxLength' => 1024, 'minLength' => 0],
],
[
'name' => 'Managers',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签管理员列表。',
'type' => 'array',
'items' => ['description' => '标签管理员。', 'type' => 'string', 'required' => false, 'example' => '12345'],
'required' => false,
'maxItems' => 20,
'minItems' => 0,
],
],
],
'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' => '0bc1ec921****'],
'Success' => ['description' => '请求是否成功。', '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.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec921****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新标签',
'description' => '需要购买DataWorks企业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateDataQualityAlertRule' => [
'summary' => '用于更新指定的数据质量监控告警规则。',
'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' => '告警规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '105412'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
],
[
'name' => 'Condition',
'in' => 'formData',
'schema' => ['description' => '数据质量监控告警规则告警条件。', 'type' => 'string', 'required' => false, 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }'],
],
[
'name' => 'Target',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控告警规则关注目标。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象的类型，只支持 DataQualityScan。', 'type' => 'string', 'required' => false, 'example' => 'DataQualityScan'],
'Ids' => [
'description' => '监控目标ID列表，目前只支持设置一个。',
'type' => 'array',
'items' => ['description' => '监控目标ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7638999336'],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'Notification',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '告警通知配置。',
'type' => 'object',
'properties' => [
'Channels' => [
'description' => '渠道列表，除了可以同时设置 Email 和 Sms 外，其他的情况都只能设置一种渠道。',
'type' => 'array',
'items' => [
'description' => '告警通道。'."\n"
.'- Dingding'."\n"
.'- Weixin'."\n"
.'- Mail'."\n"
.'- Sms'."\n"
.'- Phone'."\n"
.'- Webhook'."\n"
.'- Feishu',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Sms',
'enum' => ['Dingding', 'Weixin', 'Mail', 'Sms', 'Phone', 'Webhook', 'Feishu'],
],
'required' => true,
],
'Receivers' => [
'description' => '告警接收对象。',
'type' => 'array',
'items' => [
'description' => '告警接收对象。',
'type' => 'object',
'properties' => [
'Extension' => ['description' => '告警对象需要的额外配置，当 ReceiverType 为 DingdingUrl，支持设置 `{"atAll":true}` @所有人。', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n"],
'ReceiverType' => [
'description' => '告警接收对象类型。'."\n"
.'- AliUid'."\n"
.'- WebhookUrl'."\n"
.'- DingdingUrl'."\n"
.'- WeixinUrl'."\n"
.'- FeishuUrl'."\n"
.'- TaskOwner'."\n"
.'- DataQualityScanOwner'."\n"
.'- ShiftSchedule',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'TaskOwner',
'enum' => ['AliUid', 'WebhookUrl', 'DingdingUrl', 'WeixinUrl', 'FeishuUrl', 'TaskOwner', 'DataQualityScanOwner', 'ShiftSchedule'],
],
'ReceiverValues' => [
'description' => '告警接收对象值。',
'type' => 'array',
'items' => ['description' => '告警接收对象值。'."\n"
.'- 当 ReceiverType 为 AliUid 时填阿里云UID'."\n"
.'- 当 ReceiverType 为 ShiftSchedule 时填值班表ID'."\n"
.'- 当 ReceiverType 为 WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl 时填入对应的 URL。', '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' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'Success' => ['description' => '告警规则是否更新成功。'."\n", 'type' => 'boolean', 'example' => 'True'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新数据质量告警规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateDataQualityEvaluationTask' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'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' => '数据质量监控对象',
'type' => 'object',
'properties' => [
'DatabaseType' => [
'title' => '表所属的数据库类型',
'description' => '表所属的数据库类型'."\n"
.'- maxcompute'."\n"
.'- hologres'."\n"
.'- cdh'."\n"
.'- analyticdb_for_mysql'."\n"
.'- starrocks'."\n"
.'- emr'."\n"
.'- analyticdb_for_postgresql',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'maxcompute',
],
'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => '表在数据地图中的唯一ID', 'type' => 'string', 'required' => false, 'example' => 'odsp.openapi.ods_d_openapi_log'],
'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => '分区表的分区设置', 'type' => 'string', 'required' => false, 'example' => 'dt=$[yyyymmdd-1]', 'maxLength' => 255],
],
'required' => false,
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '质量监控任务描述', 'description' => '质量监控任务描述', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI data quality monitoring test.', 'maxLength' => 65535],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '质量监控任务名称', 'description' => '质量监控任务名称', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI data quality monitoring test.', 'maxLength' => 255],
],
[
'name' => 'RuntimeConf',
'in' => 'formData',
'schema' => ['title' => '扩展配置', 'description' => '扩展配置，JSON格式的字符串，只对EMR类型的数据质量监控生效。'."\n"
."\n"
.'- queue：执行EMR数据质量校验时，使用的yarn队列，默认为本项目配置的队列'."\n"
.'- sqlEngine：执行EMR的数据校验时，采用的SQL引擎'."\n"
.' + HIVE_SQL'."\n"
.' + SPARK_SQL', 'type' => 'string', 'required' => false, 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'],
],
[
'name' => 'Trigger',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '数据质量校验任务的触发配置',
'description' => '数据质量校验任务的触发配置',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '质量监控任务触发类型',
'description' => '质量监控触发类型。'."\n"
.'- ByScheduledTaskInstance：关联调度任务触发'."\n"
.'- ByManual：手动触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'ByScheduledTaskInstance',
],
'TaskIds' => [
'title' => '调度任务Ids',
'description' => '调度任务Id列表，在Type为ByScheduledTaskInstance时有效',
'type' => 'array',
'items' => ['description' => '调度任务节点ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1004979033'],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['title' => '项目空间Id', 'description' => '项目空间Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'],
],
[
'name' => 'Hooks',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '回调设置',
'description' => '回调设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => 'Hook类型',
'description' => '数据质量校验结束后，执行的Hook动作'."\n"
."\n"
.'- BlockTaskInstance：阻塞调度任务',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'ByScheduledTaskInstance',
],
'Condition' => ['title' => 'Hook触发条件', 'description' => 'Hook触发条件，当满足这个条件时，会触发hook动作。目前只能支持两种条件表达式：'."\n"
."\n"
.'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件。'."\n"
.'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => '通知订阅配置',
'type' => 'object',
'properties' => [
'Condition' => ['title' => '通知触发条件', 'description' => '通知触发条件，当满足这个条件时，会触发消息通知。目前只能支持两种条件表达式：'."\n"
."\n"
.'- 只指定一组规则严重类型和规则校验状态，如`${severity} == "High" AND ${status} == "Critical"`，代表执行的规则中，如果有severity为High的规则校验结果是Critical，则满足条件'."\n"
.'- 指定多组规则严重类型和规则校验状态，如`(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`，代表执行的规则中，如果有severity为High的规则校验结果是Critical、或者severity为Normal的规则校验结果是Critical、或者severity为Normal的规则校验结果是Error，则满足条件，条件表达式中severity的枚举与DataQualityRule中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', 'type' => 'string', 'required' => false, 'example' => '${severity} == "High" AND ${status} == "Critical"'],
'Notifications' => [
'title' => '通知设置',
'description' => '通知设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NotificationReceivers' => [
'title' => '告警接收人设置',
'description' => '告警接收人设置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ReceiverType' => [
'title' => '告警接收人类型',
'description' => '告警接收人类型',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['WebhookUrl' => '自定义Webhook地址', 'FeishuUrl' => '飞书通知地址', 'DingdingUrl' => '钉钉群机器人地址', 'WeixinUrl' => '微信通知地址', 'AliUid' => '阿里云用户ID'],
'example' => 'DingdingUrl',
],
'Extension' => [
'title' => '扩展信息',
'description' => '告警发送时的额外参数设置，json格式，支持的key如下：'."\n"
."\n"
.'- atAll：发送钉钉告警时，是否需要在群里@所有人。ReceiverType为DingdingUrl时生效。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '{ "atAll": true }'."\n",
],
'ReceiverValues' => [
'title' => '告警接收人',
'description' => '告警接收人',
'type' => 'array',
'items' => ['description' => '接收方取值。'."\n"
."\n"
.'- 当接收方类型为阿里云ID时，接收方取值为具体阿里云用户ID。'."\n"
.'- 当接收方类型为DingdingUrl时，接收方取值为具体钉钉机器人的告警地址。'."\n"
.'- 当接收方类型为WeixinUrl时，接收方取值为具体企业微信的告警地址。'."\n"
.'- 当接收方类型为FeishuUrl时，接收方取值为具体飞书的告警地址。'."\n"
.'- 当接收方类型为WebhookUrl时，接收方取值为具体自定义Webhook的告警地址。', 'type' => 'string', 'required' => false, 'example' => 'https://api.fc.aliyuncs.com/webhook', 'maxLength' => 255],
'required' => false,
],
],
'required' => false,
'description' => '告警接收人设置',
],
'required' => false,
],
'NotificationChannels' => [
'title' => '通知方式',
'description' => '通知方式',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Channels' => [
'title' => '通知方式',
'description' => '通知方式',
'type' => 'array',
'items' => [
'description' => '通知方式'."\n"
."\n"
.'- Dingding：钉钉群机器人'."\n"
.'- Mail：邮件'."\n"
.'- Weixin：微信通知'."\n"
.'- Feishu：飞书通知'."\n"
.'- Phone：电话'."\n"
.'- Sms：短信'."\n"
.'- Webhook：自定义Webhook',
'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' => '数据源ID，您可以调用[ListDataSources](~~211431~~)获取数据源的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '358750'],
],
[
'name' => 'DataQualityRules',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控关联的数据质量规则列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据质量规则名称。', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI test rules', 'maxLength' => 255],
'Enabled' => ['description' => '数据质量规则是否启用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Severity' => [
'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n"
.'- Normal'."\n"
.'- High',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['High', 'Normal'],
],
'Description' => ['description' => '数据质量规则描述信息。', 'type' => 'string', 'required' => false, 'example' => 'OpenAPI test rules', 'maxLength' => 500],
'TemplateCode' => ['description' => '规则所引用的规则模板唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM:field:null_value:fixed:0'],
'SamplingConfig' => [
'description' => '样本采集时，所需的参数',
'type' => 'object',
'properties' => [
'Metric' => [
'description' => '采样的指标名称'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CountNotIn',
],
'MetricParameters' => ['description' => '样本采集时，所需的参数', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'type' => 'string', 'required' => false, 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', 'maxLength' => 1000],
'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'type' => 'string', 'required' => false, 'example' => 'status != \'Succeeded\''."\n"],
],
'required' => false,
],
'CheckingConfig' => [
'description' => '样本校验设置',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '阈值计算方式'."\n"
."\n"
.'- Fluctation：波动范围校验'."\n"
.'- Auto：智能阈值校验'."\n"
.'- FluctationDiscreate：离散值波动范围校验'."\n"
.'- Average：均值波动范围校验'."\n"
.'- Fixed：固定值校验',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Fixed',
],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'required' => false, 'example' => '{"bizdate": ["-1"]}'."\n"],
'Thresholds' => [
'description' => '校验阈值设置。',
'type' => 'object',
'properties' => [
'Expected' => [
'description' => '期望的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => [
'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '=',
],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'required' => false, 'example' => '0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'],
],
'required' => false,
],
'Warned' => [
'description' => '普通警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => [
'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '>',
],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'required' => false, 'example' => '0.001'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'],
],
'required' => false,
],
'Critical' => [
'description' => '严重警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => [
'description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '>',
],
'Value' => ['description' => '阈值数值。', 'type' => 'string', 'required' => false, 'example' => '0.01'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'],
],
'required' => false,
],
],
'required' => false,
],
],
'required' => false,
],
'ErrorHandlers' => [
'description' => '质量规则校验问题处理器',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '处理器类型：'."\n"
."\n"
.'- SaveErrorData：保留问题数据',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'SaveErrorData',
],
'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', 'type' => 'string', 'required' => false, 'example' => 'SELECT * FROM ods_d_openapi_log WHERE status = \'Error\''],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'Id' => ['description' => '校验规则的ID。您可以调用[ListQualityRules](~~173995~~)接口获取规则ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1022171560'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '7227061794'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'],
],
'title' => '更新数据质量监控',
'summary' => '更新数据质量校验任务。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-15T08:29:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]',
],
'UpdateDataQualityRule' => [
'summary' => '更新质量规则。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247829',
'abilityTreeNodes' => ['FEATUREdide3WJOKE'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100001'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'type' => 'string', 'required' => false, 'example' => 'The table cannot be empty.', 'maxLength' => 255],
],
[
'name' => 'Enabled',
'in' => 'formData',
'schema' => ['description' => '规则是否启用', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
'name' => 'Severity',
'in' => 'formData',
'schema' => [
'description' => '规则对于业务的等级（对应页面上的强弱规则），可选的枚举值：'."\n"
.'- Normal'."\n"
.'- High',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'High',
'enum' => ['High', 'Normal'],
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '规则描述信息，最长500个字符', 'type' => 'string', 'required' => false, 'example' => 'this is a odps _sql task'."\n", 'maxLength' => 500],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'],
],
[
'name' => 'TemplateCode',
'in' => 'formData',
'schema' => ['description' => '规则所引用的规则模板唯一标识', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM:table:table_count:fixed'],
],
[
'name' => 'SamplingConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '样本采集所需的设置',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称，使用模版时可不设置'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'required' => false, 'example' => 'Min'],
'MetricParameters' => ['description' => '样本采集时，所需的参数', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}'],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'type' => 'string', 'required' => false, 'example' => 'SET odps.sql.udf.timeout=600s; '."\n"
.'SET odps.sql.python.version=cp27;', 'maxLength' => 1000],
'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'type' => 'string', 'required' => false, 'example' => 'id IS NULL'."\n"],
],
'required' => false,
],
],
[
'name' => 'CheckingConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '样本校验设置',
'type' => 'object',
'properties' => [
'Type' => ['description' => '阈值计算方式，使用模版时可不设置'."\n"
.'- Fixed'."\n"
.'- Fluctation'."\n"
.'- FluctationDiscreate'."\n"
.'- Auto'."\n"
.'- Average'."\n"
.'- Variance', 'type' => 'string', 'required' => false, 'example' => 'Fixed'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n"],
'Thresholds' => [
'description' => '阈值设置',
'type' => 'object',
'properties' => [
'Expected' => [
'description' => '期望的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- <'."\n"
.'- <='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'required' => false, 'example' => '>'],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'required' => false, 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue <= 0.01'],
],
'required' => false,
],
'Warned' => [
'description' => '普通警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'required' => false, 'example' => '>'],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'required' => false, 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'],
],
'required' => false,
],
'Critical' => [
'description' => '严重警告的阈值设置',
'type' => 'object',
'properties' => [
'Operator' => ['description' => '比较符'."\n"
.'- \\>'."\n"
.'- \\>='."\n"
.'- \\<'."\n"
.'- \\<='."\n"
.'- !='."\n"
.'- =', 'type' => 'string', 'required' => false, 'example' => '>'],
'Value' => ['description' => '阈值数值', 'type' => 'string', 'required' => false, 'example' => '100.0'],
'Expression' => ['description' => '阈值表达式。'."\n"
."\n"
.'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n"
."\n"
.'- 波动上升大于0.01： $checkValue > 0.01 '."\n"
.'- 波动下降大于0.01：$checkValue < -0.01 '."\n"
.'- 波动率绝对值：abs($checkValue) > 0.01'."\n"
."\n"
.'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.05'],
],
'required' => false,
],
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'ErrorHandlers',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '质量规则校验问题处理器列表',
'type' => 'array',
'items' => [
'description' => '质量规则校验问题处理器',
'type' => 'object',
'properties' => [
'Type' => ['description' => '处理器类型：'."\n"
.'- SaveErrorData', 'type' => 'string', 'required' => false, 'example' => 'SaveErrorData'],
'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', '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' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"],
'Success' => ['description' => '更新是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新质量规则',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'extraInfo' => '规则模版Code列表：'."\n"
.'- 自定义SQL：SYSTEM:user_defined_sql'."\n"
."\n"
.'- 表行数大于0：SYSTEM:table:table_count:fixed:0'."\n"
.'- 表行数，固定值：SYSTEM:table:table_count:fixed'."\n"
.'- 表行数，1天差值：SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n"
.'- 表行数，上周期差值：SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n"
.'- 表行数，上周期波动率：SYSTEM:table:table_count:cycle:latest_bizdate'."\n"
.'- 表行数，7天平均值波动率：SYSTEM:table:table_count:avg:7_bizdate'."\n"
.'- 表行数，30天平均值波动率：SYSTEM:table:table_count:avg:1m_bizdate'."\n"
.'- 表行数，1天波动率：SYSTEM:table:table_count:flux:1_bizdate'."\n"
.'- 表行数，7天波动率：SYSTEM:table:table_count:flux:7_bizdate'."\n"
.'- 表行数，30天波动率：SYSTEM:table:table_count:flux:1m_bizdate'."\n"
.'- 表行数，1，7，30天波动率：SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n"
.'- 表行数，1，7，30天，本月1号，波动率：SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n"
.'- 表行数，自定义范围：SYSTEM:table:count'."\n"
.'- 条件匹配占比，自定义范围：SYSTEM:table:count_percent'."\n"
."\n"
.'- 平均值，1天波动率：SYSTEM:field:avg:cycle:1_bizdate'."\n"
.'- 平均值，1、7、30天波动率：SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n"
.'- 平均值，自定义范围：SYSTEM:field:avg'."\n"
."\n"
.'- 汇总值，1天波动率：SYSTEM:field:sum:cycle:1_bizdate'."\n"
.'- 汇总值，上周期波动率：SYSTEM:field:sum:cycle:latest_bizdate'."\n"
.'- 汇总值，1、7、30天波动率：SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n"
.'- 汇总值，自定义范围：SYSTEM:field:sum'."\n"
."\n"
.'- 最小值，1天波动率：SYSTEM:field:min:cycle:1_bizdate'."\n"
.'- 最小值，上周期波动率：SYSTEM:field:min:cycle:latest_bizdate'."\n"
.'- 最小值，1、7、30天波动率：SYSTEM:field:min:flux:1_7_1m_bizdate'."\n"
.'- 最小值，自定义范围：SYSTEM:field:min'."\n"
."\n"
.'- 最大值，1天波动率：SYSTEM:field:max:cycle:1_bizdate'."\n"
.'- 最大值，上周期波动率：SYSTEM:field:max:cycle:latest_bizdate'."\n"
.'- 最大值，1、7、30天波动率：SYSTEM:field:max:flux:1_7_1m_bizdate'."\n"
.'- 最大值，自定义范围：SYSTEM:field:max'."\n"
."\n"
.'- 空值记录数为0：SYSTEM:field:null_value:fixed:0'."\n"
.'- 空值个数，固定值：SYSTEM:field:null_value:fixed'."\n"
.'- 空值个数/总行数，固定值：SYSTEM:field:null_value_percent:fixed'."\n"
."\n"
.'- 字段重复值为0：SYSTEM:field:duplicated_count:fixed:0'."\n"
.'- 重复值个数/总行数，固定值：SYSTEM:field:duplicated_percent:fixed'."\n"
.'- 重复值个数，固定值：YSTEM:field:duplicated_count:fixed'."\n"
.'- 多字段重复值为0：SYSTEM:fields:duplicated_count:fixed:0'."\n"
."\n"
.'- 离散值（状态值），固定值：SYSTEM:field:all_discrete_count:fixed'."\n"
.'- 离散值（分组个数及状态值），1、7、30天波动率：SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n"
.'- 离散值（分组个数），固定值：SYSTEM:field:discrete_group_count:fixed'."\n"
.'- 离散值（分组个数），1天波动率：SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n"
."\n"
.'- 表大小，固定值：SYSTEM:table:table_size:fixed'."\n"
.'- 表大小，上周期差值：SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n"
.'- 表大小，相比1天前差值（字节）：SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n"
.'- 表大小，1天波动率：SYSTEM:table:table_size:flux:1_bizdate'."\n"
.'- 表大小，7天波动率：SYSTEM:table:table_size:flux:7_bizdate'."\n"
.'- 表大小，30天波动率：SYSTEM:table:table_size:flux:1m_bizdate'."\n"
."\n"
.'- 唯一值个数，固定值：SYSTEM:field:count_distinct:fixed'."\n"
.'- 唯一值个数，1、7、30天波动率：SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n"
.'- 唯一值个数/总行数，固定值：SYSTEM:field:count_distinct_percent:fixed'."\n"
."\n"
.'- 表行数，动态阈值：SYSTEM:table:table_count:dynamic_threshold'."\n"
.'- 汇总值，动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 平均值，动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 最大值，动态阈值：SYSTEM:field:max:dynamic_threshold'."\n"
.'- 最小值，动态阈值：SYSTEM:field:min:dynamic_threshold'."\n"
.'- 唯一值率动态阈值：SYSTEM:table:table_size:dynamic_threshold'."\n"
.'- 唯一值个数，动态阈值：SYSTEM:table:distinct_count:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:avg:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:sum:dynamic_threshold'."\n"
.'- 离散值（分组个数），动态阈值：SYSTEM:field:discrete_group_count:dynamic_threshold'."\n"
.'- 离散值（状态值），动态阈值：SYSTEM:field:discrete_value_count:dynamic_threshold',
'changeSet' => [
['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateDataQualityRuleTemplate' => [
'summary' => '更新质量规则模版。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '248082',
'abilityTreeNodes' => ['FEATUREdideRGVRPF'],
],
'parameters' => [
[
'name' => 'Code',
'in' => 'formData',
'schema' => ['description' => '规则模版Code', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_DEFINED:123'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '规则模板名称，数字、英文字母、汉字、半角全角标点符号组合，最长512个字符', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Table row Count Verification'."\n", 'maxLength' => 128],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。'."\n"
."\n"
.'该参数用来确定本次API调用操作使用的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'],
],
[
'name' => 'DirectoryPath',
'in' => 'formData',
'schema' => ['description' => '自定义模板被存放的类目目录，斜线分隔层级。每个层级名称最长1024个字符，由不能包含空白字符、不能包含斜线', 'type' => 'string', 'required' => false, 'example' => '/ods/order_data'],
],
[
'name' => 'SamplingConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '样本采集所需的设置',
'type' => 'object',
'properties' => [
'Metric' => ['description' => '采样的指标名称'."\n"
.'- Count：表行数'."\n"
.'- Min：字段最小值'."\n"
.'- Max：字段最大值'."\n"
.'- Avg：字段均值'."\n"
.'- DistinctCount：字段唯一值个数'."\n"
.'- DistinctPercent：字段唯一值个数与数据行数占比'."\n"
.'- DuplicatedCount：字段重复值个数'."\n"
.'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n"
.'- TableSize：表大小'."\n"
.'- NullValueCount：字段为空的行数'."\n"
.'- NullValuePercent：字段为空的比例'."\n"
.'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n"
.'- CountNotIn：枚举值不匹配行数'."\n"
.'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n"
.'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'required' => false, 'example' => 'Max'],
'MetricParameters' => ['description' => '样本采集时，所需的参数', 'type' => 'string', 'required' => false, 'example' => '{"SQL": "select count(1) from table;"}'."\n"],
'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', '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' => '样本校验设置',
'type' => 'object',
'properties' => [
'Type' => ['description' => '监控对象类型'."\n"
."\n"
.'- Table', 'type' => 'string', 'required' => false, 'example' => 'Table'],
'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n"],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-****'."\n"],
'Success' => ['description' => '更新是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => [
'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityTemplate'],
'returnType' => 'synchronous',
],
'title' => '更新质量规则模版',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [
['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateDataQualityScan' => [
'summary' => '更新数据质量监控。',
'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' => '数据质量监控描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Daily data quality scanning of ods tables.'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '数据质量监控所在的DataWorks工作空间ID。您可以通过[ListProjects](~~2852607~~)接口获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据质量监控ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '数据质量监控负责人用户ID。', 'type' => 'string', 'required' => false, 'example' => '231263586109857423'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '数据质量监控的内容的Spec代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "datasets": ['."\n"
.' {'."\n"
.' "type": "Table",'."\n"
.' "dataSource": {'."\n"
.' "name": "odps_first",'."\n"
.' "envType": "Prod"'."\n"
.' },'."\n"
.' "tables": ['."\n"
.' "ods_d_user_info"'."\n"
.' ],'."\n"
.' "filter": "pt = $[yyyymmdd-1]"'."\n"
.' }'."\n"
.' ],'."\n"
.' "rules": ['."\n"
.' {'."\n"
.' "assertion": "row_count > 0"'."\n"
.' }, {'."\n"
.' "templateId": "SYSTEM:field:null_value:fixed",'."\n"
.' "pass": "when = 0",'."\n"
.' "name": "The id cannot be empty.",'."\n"
.' "severity": "High",'."\n"
.' "identity": "a-customized-data-quality-rule-uuid"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
[
'name' => 'Parameters',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控执行参数定义。',
'type' => 'array',
'items' => [
'description' => '参数信息。',
'type' => 'object',
'properties' => [
'Value' => ['description' => '参数值。', 'type' => 'string', 'required' => false, 'example' => 'smtp.qiye.aliyun.com'],
'Name' => ['description' => '参数名。', 'type' => 'string', 'required' => false, 'example' => 'temp_237669.zip_byBwm_1734661241752'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'RuntimeResource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控运行时，使用的资源组。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => '20315'],
'Cu' => ['description' => '运行配置CU消耗。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx'],
],
'required' => false,
],
],
[
'name' => 'ComputeResource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控在运行时使用的计算引擎，可空，如果没有指定，则使用Spec中所指定的数据源连接。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '计算引擎名称，唯一标识。', 'type' => 'string', 'required' => false, 'example' => 'auto_createAlertRule_Finished_1kUTk6'],
'Runtime' => [
'description' => '使用计算引擎时的更多设置。',
'type' => 'object',
'properties' => [
'Engine' => [
'description' => '使用的引擎类型，只有EMR计算引擎支持设置这部分内容。 取值范围：'."\n"
.'- Hive：Hive SQL'."\n"
.'- Spark：Spark SQL'."\n"
.'- Kyuubi',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Hive',
],
'SparkConf' => ['description' => '使用Spark引擎时，更多的参数设置，目前只支持通过spark.yarn.queue设置队列。', 'type' => 'object', 'required' => false, 'example' => 'spark.yarn.queue=dq_queue'],
'HiveConf' => ['description' => '使用Hive引擎时，更多的参数设置，目前只支持通过mapreduce.job.queuename设置队列。', 'type' => 'object', 'required' => false, 'example' => 'mapreduce.job.queuename=dq_queue'],
],
'required' => false,
],
'EnvType' => [
'description' => '计算引擎所属的项目环境。取值范围：'."\n"
.'- Prod：生产环境'."\n"
.'- Dev：开发环境',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
'required' => false,
],
],
[
'name' => 'Trigger',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控触发设置。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '数据质量监控触发方式。取值范围：'."\n"
.'- ByManual：手动触发，默认设置'."\n"
.'- BySchedule：调度任务实例触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'BySchedule',
],
'TaskIds' => [
'description' => '当触发方式为BySchedule时，需要配置触发质量监控的调度任务ID。',
'type' => 'array',
'items' => ['description' => '调度任务Id。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30001'],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'Hooks',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'array',
'items' => [
'description' => '数据质量监控运行结束后的Hook配置。',
'type' => 'object',
'properties' => [
'Condition' => ['description' => 'Hook触发条件，当满足这个条件时，会触发Hook运行。目前只支持一种表达式写法：'."\n"
."\n"
.'指定多组规则严重类型和规则校验状态，如`results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`，代表执行的规则中，如果有severity为Normal的规则校验结果是Fail、或者severity为High的规则校验结果是Error、或者severity为High的规则校验结果是Warn，则满足条件。条件表达式中severity的枚举与Spec中severity的枚举一致、status的枚举与DataQualityResult中的status一致。', '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' => 'Hook类型。取值范围：'."\n"
.'- BlockTaskInstance：阻塞任务实例调度',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'BlockTaskInstance',
'enum' => ['BlockTaskInstance'],
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '数据质量监控名称。', 'type' => 'string', 'required' => false, 'example' => 'data_quality_scan_001'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'],
'Success' => ['description' => '调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新数据质量监控',
'description' => '需要购买DataWorks基础版及以上版本才能使用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateDataQualityTemplate' => [
'summary' => '用于更新指定项目下的数据质量规则模板配置。',
'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' => '自定义规则模板ID。', 'type' => 'string', 'required' => false, 'example' => 'USER_DEFINED:2001'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => '项目ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '规则模板详细配置 Spec 代码，详情请参见[数据质量Spec配置说明](~~2963394~~)。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "assertion": "anomaly detection fro id_not_null_cnt",'."\n"
.' "id_not_null_cnt": {'."\n"
.' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n"
.' },'."\n"
.' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n"
.'}'],
],
[
'name' => 'Owner',
'in' => 'query',
'schema' => ['description' => '责任人的账号ID。', 'type' => 'string', 'required' => false, 'example' => '95279527****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0bc14115***159376359'],
'Success' => ['description' => '规则模板是否更新成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新数据质量规则模板',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateDataSource' => [
'summary' => '根据数据源ID，修改指定的数据源。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '232392',
'abilityTreeNodes' => ['FEATUREdideRWC5F7'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '数据源Id', 'description' => '数据源ID，数据源的唯一标识符。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '16033'],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['title' => 'Dataworks项目空间Id', 'description' => 'DataWorks项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5678'],
],
[
'name' => 'ConnectionPropertiesMode',
'in' => 'query',
'schema' => [
'title' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式',
'description' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数约束，场景举例：'."\n"
.'- InstanceMode：实例模式。'."\n"
.'- UrlMode：连接串模式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'UrlMode',
'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'],
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '数据源描述信息，长度不超过 3000 个字符', 'description' => '数据源描述信息，长度不超过 3000 个字符。', 'type' => 'string', 'required' => false, 'example' => 'test '],
],
[
'name' => 'ConnectionProperties',
'in' => 'query',
'schema' => ['title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', 'description' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括'."\n"
.'- Dev（开发环境）'."\n"
.'- Prod（生产环境）'."\n"
."\n"
.'不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考[数据源连接信息ConnectionProperties](~~2852465~~)', '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' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '102E8E24-0387-531D-8A75-1C0AE7DD03E5'],
'Success' => ['description' => '数据源是否修改成功：'."\n"
."\n"
.'- true：是'."\n"
."\n"
.'- false：否', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改数据源',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。'."\n"
.'2. 需要在DataWorks项目空间中具有如下至少一种角色：'."\n"
.'- 租户所有者、租户管理员、空间管理员、项目所有者、运维',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:UpdateDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102E8E24-0387-531D-8A75-1C0AE7DD03E5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateDataset' => [
'summary' => '更新数据集信息，仅支持DataWorks数据集，要求操作者为数据集的创建者或数据集所在工作空间的管理员',
'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' => '数据集ID,仅支持更新DataWorks数据集', 'type' => 'string', 'required' => true, 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '数据集名称，非空字符串，长度不超过128', 'description' => '数据集名称，非空字符串，长度不超过128', 'type' => 'string', 'required' => false, 'example' => 'test_oss_dataset_new'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '数据集描述,长度不超过1024', 'description' => '数据集描述,长度不超过1024', 'type' => 'string', 'required' => false, 'example' => 'new comment'],
],
[
'name' => 'Readme',
'in' => 'formData',
'schema' => ['title' => '使用说明，支持Markdown格式富文本', 'description' => '使用说明，支持Markdown格式富文本', 'type' => 'string', 'required' => false, 'example' => '## introduction'],
],
],
'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' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'Success' => ['title' => '是否更新成功', 'description' => '是否更新成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新数据集',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateDatasetVersion' => [
'summary' => '更新数据集版本信息，仅支持DataWorks数据集，要求操作者为数据集的创建者或数据集所在工作空间的管理员',
'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' => '数据集版本ID,仅支持更新DataWorks数据集', 'type' => 'string', 'required' => true, 'example' => ' '."\n"
.'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n"
.':2'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '数据集版本描述,长度不超过1024', 'description' => '数据集版本描述,长度不超过1024', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
],
],
'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' => 'A090666C-74FB-5629-ABFC-2FE99DD55XXX'],
'Success' => ['title' => '是否更新成功', 'description' => '是否更新成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新数据集版本信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A090666C-74FB-5629-ABFC-2FE99DD55XXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'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' => '文件所在的路径'."\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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面获取ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001'],
],
[
'name' => 'FileName',
'in' => 'formData',
'schema' => ['description' => '文件的名称。'."\n"
.'您可以通过重新设置FileName的值来修改文件名称。'."\n"
.'例如，使用[ListFiles](~~173942~~)接口查询目标目录下的文件ID，通过[UpdateFile](~~173951~~)接口，输入查询的文件ID至FileId参数，并配置FileName的参数值，即可修改相应文件的名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ods_user_info_d'],
],
[
'name' => 'FileDescription',
'in' => 'formData',
'schema' => ['description' => '文件的描述'."\n"
.'。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Here is the file description'],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => '文件代码内容，不同代码类型（fileType）的文件，代码格式不同。'."\n"
.'您可以在运维中心，右键单击对应类型的任务，选择查看代码，查看具体的代码格式。', 'type' => 'string', 'required' => false, 'example' => 'SELECT "1";'],
],
[
'name' => 'AutoRerunTimes',
'in' => 'formData',
'schema' => ['description' => '文件出错后，'."\n"
.'自动重跑的次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '3'],
],
[
'name' => 'AutoRerunIntervalMillis',
'in' => 'formData',
'schema' => ['description' => '失败自动重跑时间间隔，单位为毫秒。最大为1800000毫秒（30分钟）。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>失败自动重跑”的”重跑间隔“配置对应。'."\n"
.'控制台中“重跑间隔”的时间单位为分钟，请在调用时注意转换时间。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120000'],
],
[
'name' => 'RerunMode',
'in' => 'formData',
'schema' => [
'description' => '重跑属性。取值如下：'."\n"
."\n"
.'- ALL_ALLOWED：运行成功或失败后皆可重跑。'."\n"
.'- FAILURE_ALLOWED：运行成功后不可重跑，运行失败后可以重跑。'."\n"
.'- ALL_DENIED：运行成功或失败皆不可重跑。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>重跑属性”配置内容对应。',
'type' => 'string',
'required' => false,
'example' => 'ALL_ALLOWED',
'enum' => ['ALL_ALLOWD', 'FAILURE_ALLOWED', 'ALL_DENIED', 'ALL_ALLOWED'],
],
],
[
'name' => 'Stop',
'in' => 'formData',
'schema' => ['description' => '是否暂停调度，取值如下：'."\n"
."\n"
.'- true：暂停调度。'."\n"
.'- false：不暂停调度。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度类型”配置为“暂停调度”时对应。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ParaValue',
'in' => 'formData',
'schema' => ['description' => '调度参数。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度参数”对应。您可以参考[调度参数](~~137548~~)配置。', 'type' => 'string', 'required' => false, 'example' => 'x=a y=b z=c'],
],
[
'name' => 'StartEffectDate',
'in' => 'formData',
'schema' => ['description' => '开始自动调度的毫秒时间戳。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的开始时间的毫秒时间戳对应。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '936923400000'],
],
[
'name' => 'EndEffectDate',
'in' => 'formData',
'schema' => ['description' => '停止自动调度的时间戳，单位为毫秒。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>生效日期”配置的结束时间的毫秒时间戳对应。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '4155787800000'],
],
[
'name' => 'CronExpress',
'in' => 'formData',
'schema' => ['description' => '周期调度的cron表达式，该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>cron表达式”对应。配置完“调度周期”及“定时调度时间”后，DataWorks会自动生成相应cron表达式。'."\n"
."\n\n"
.'示例如下：'."\n"
."\n"
.'- 每天凌晨5点30分定时调度：`00 30 05 * * ?`。'."\n"
."\n"
.'- 每个小时的第15分钟定时调度：`00 15 * * * ?`。'."\n"
."\n"
.'- 每隔十分钟调度一次：`00 00/10 * * * ?`。'."\n"
."\n"
.'- 每天8点到17点，每个十分钟调度一次：`00 00-59/10 8-23 * * * ?`。'."\n"
."\n"
.'- 每月的1日0点20分自动调度：`00 20 00 1 * ?`。'."\n"
."\n"
.'- 从1月1日0点10分开始，每过3个月调度一次：`00 10 00 1 1-12/3 ?`。'."\n"
."\n"
.'- 每周二、周五的0点5分自动调度：`00 05 00 * * 2,5`。'."\n"
."\n\n"
.'由于DataWorks调度系统的规则，cron表达式有以下限制：'."\n"
."\n"
.'- 最短调度间隔时间为5分钟。'."\n"
."\n"
.'- 每天最早调度时间为0点5分。', 'type' => 'string', 'required' => false, 'example' => '00 00-59/5 1-23 * * ?'],
],
[
'name' => 'CycleType',
'in' => 'formData',
'schema' => [
'description' => '调度周期的类型，包括NOT_DAY（分钟、小时）和DAY（日、周、月）。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>时间属性>调度周期”对应。',
'type' => 'string',
'required' => false,
'example' => 'NOT_DAY',
'default' => 'DAY',
'enum' => ['DAY', 'NOT_DAY'],
],
],
[
'name' => 'DependentType',
'in' => 'formData',
'schema' => [
'description' => '依赖上一周期的方式。取值如下：'."\n"
."\n"
.'- SELF：依赖项选择本节点。'."\n"
.'- CHILD：依赖项选择一级子节点。'."\n"
.'- USER_DEFINE：依赖项选择其他节点。'."\n"
.'- NONE：未选择依赖项，即不会依赖上一周期。',
'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' => '当DependentType参数配置为USER_DEFINE时，用于设置当前文件具体依赖的节点ID。依赖多个节点时，使用英文逗号（,）分隔。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“跨周期依赖（原上一周期）”后，依赖项选择“其他节点”时配置的内容对应。', 'type' => 'string', 'required' => false, 'example' => '5,10,15,20'],
],
[
'name' => 'InputList',
'in' => 'formData',
'schema' => ['description' => '文件依赖的上游文件的输出名称。依赖多个输出时，使用英文逗号（,）分隔。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”中配置的“上游节点输出名”对应。'."\n"
."\n"
.'> 通过CreateDISyncTask和UpdateFile方式创建离线同步任务时此参数必须配置。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'project_root,project.file1,project.001_out'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的名称。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间名称。'."\n"
."\n\n"
.'该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => ['description' => '文件的ID。'."\n"
.'您可以调用[ListFiles](~~173942~~)接口获取文件ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100000001'],
],
[
'name' => 'OutputList',
'in' => 'formData',
'schema' => ['description' => '文件的输出。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”中配置的“本节点的输出名称”对应。', 'type' => 'string', 'required' => false, 'example' => 'dw_project.ods_user_info_d'],
],
[
'name' => 'ResourceGroupIdentifier',
'in' => 'formData',
'schema' => ['description' => '文件发布成任务后，任务执行时对应的资源组。'."\n"
.'您可以调用[ListResourceGroups](~~173913~~)获取工作空间可用的资源组列表。', 'type' => 'string', 'required' => false, 'example' => 'default_group'],
],
[
'name' => 'ConnectionName',
'in' => 'formData',
'schema' => ['description' => '文件对应任务执行时，任务使用的数据源标识符。'."\n"
.'您可以调用[ListDataSources](~~211431~~)获取可用的数据源列表。', 'type' => 'string', 'required' => false, 'example' => 'odps_source'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '文件所有者的用户'."\n"
.'ID。', 'type' => 'string', 'required' => false, 'example' => '18023848927592'],
],
[
'name' => 'AutoParsing',
'in' => 'formData',
'schema' => ['description' => '文件是否开启自动解析功能。'."\n"
.'取值如下：'."\n"
.'- true：文件会自动解析代码。'."\n"
.'- false：文件不会自动解析代码。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”的代码解析对应。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SchedulerType',
'in' => 'formData',
'schema' => [
'description' => '调度的类型，取值如下：'."\n"
."\n"
.'- NORMAL：正常调度任务。'."\n"
.'- MANUAL：手动任务，不会被日常调度，对应手动业务流程下的节点。'."\n"
.'- PAUSE：暂停任务。'."\n"
.'- SKIP：空跑任务，被日常调度，但启动调度时直接被置为成功。',
'type' => 'string',
'required' => false,
'example' => 'NORMAL',
'enum' => ['NORMAL', 'SKIP', 'PAUSE', 'MANUAL'],
],
],
[
'name' => 'AdvancedSettings',
'in' => 'formData',
'schema' => ['description' => '任务的高级配置。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“高级设置“对应。'."\n"
."\n"
.'当前仅EMR Spark Streaming和EMR Streaming SQL任务支持配置该参数，并且参数为JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}'],
],
[
'name' => 'StartImmediately',
'in' => 'formData',
'schema' => ['description' => '发布后是否立即启动。取值如下：'."\n"
."\n"
.'- true：发布后立即启动。'."\n"
.'- false：发布后暂不启动。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，EMR Spark Streaming和EMR Streaming SQL数据开发任务，编辑页面右侧导航栏的“配置>时间属性>启动方式“对应。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'InputParameters',
'in' => 'formData',
'schema' => ['description' => '节点的上下文输入参数。参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的InputContextParameterList参数结构。'."\n"
."\n\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输入参数“对应。', 'type' => 'string', 'required' => false, 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]'],
],
[
'name' => 'OutputParameters',
'in' => 'formData',
'schema' => ['description' => '节点的上下文输出参数。'."\n"
.'参数为JSON格式，包含的字段可参考[GetFile](~~173954~~)接口返回值中的OutputContextParameterList参数结构。'."\n"
."\n"
.'该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>节点上下文参数>本节点输出参数”对应。', 'type' => 'string', 'required' => false, 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]'],
],
[
'name' => 'IgnoreParentSkipRunningProperty',
'in' => 'formData',
'schema' => ['description' => '该参数与[DataWorks控制台](https://workbench.data.aliyun.com/console)中，数据开发任务的“调度配置>调度依赖”配置为“跨周期依赖（原上一周期）”后，依赖项选择“本节点”或“一级子节点”时配置的“跳过上游的空跑属性”对应。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ApplyScheduleImmediately',
'in' => 'formData',
'schema' => ['description' => '是否发布后立即生效调度配置'."\n"
.'。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Timeout',
'in' => 'formData',
'schema' => ['description' => '调度配置超时定义'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'ImageId',
'in' => 'formData',
'schema' => ['description' => '自定义镜像ID'."\n"
.'。', 'type' => 'string', 'required' => false, 'example' => 'm-uf6d7npxk1hhek8ng0cb'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFGH-IJKLMNOPQ'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJKLMNOPQ\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新已有的文件节点',
'summary' => '调用UpdateFile更新已创建的文件。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'DataWorks工作空间的ID。'."\n"
.'您可以登录DataWorks管控台，进入工作空间配置页面获取工作空间ID。该参数与ProjectIdentifier参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间名称。'."\n"
.'您可以登录DataWorks控制台，进入工作空间配置页面获取工作空间名称。该参数与ProjectId参数，二者必须设置其一，用来确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FolderId',
'in' => 'formData',
'schema' => ['description' => '文件夹的ID，'."\n"
.'您可以调用[ListFolders](~~173955~~)获取文件夹的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2735c2c19d58'],
],
[
'name' => 'FolderName',
'in' => 'formData',
'schema' => ['description' => '文件夹名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySecondFolder'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'Http状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => ' 更新文件夹的信息',
'summary' => '调用UpdateFolder更新文件夹的信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateFunction' => [
'summary' => '调用此接口，可以更新udf函数信息。更新以增量更新的方式进行，更新信息通过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' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => 'udf函数的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '463497880880954XXXX'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个udf函数的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "Function",'."\n"
.' "spec": {'."\n"
.' "functions": ['."\n"
.' {'."\n"
.' "name": "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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '12123960-CB2C-5086-868E-C6C1D024****'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
."\n"
.'true：调用成功。'."\n"
."\n"
.'false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12123960-CB2C-5086-868E-C6C1D024****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新数据开发函数信息',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateIDEEventResult' => [
'summary' => '回调扩展点消息的检查结果。',
'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' => 'DataWorks开放消息的消息ID。当触发扩展点事件后，您可以从接收到的事件消息中获取消息ID。'."\n"
."\n\n"
.'消息格式，可参考[消息格式](~~215367~~)。', 'type' => 'string', 'required' => false, 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'],
],
[
'name' => 'ExtensionCode',
'in' => 'formData',
'schema' => ['description' => '扩展程序的唯一标识。'."\n"
.'您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入开放平台的Extensions页签查看标识。', 'type' => 'string', 'required' => false, 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'],
],
[
'name' => 'CheckResult',
'in' => 'formData',
'schema' => ['description' => '扩展程序对本次扩展点事件的检查状态。取值如下：'."\n"
."\n"
.'- OK：扩展程序对本次扩展点事件检查通过。'."\n"
.'- FAIL：扩展程序对本次扩展点事件检查不通过。您需要查看并及时处理报错，以免影响后续程序的正常执行。'."\n"
.'- WARN：扩展程序对本次扩展点事件检查通过，但存在警告。', 'type' => 'string', 'required' => false, 'example' => 'OK'],
],
[
'name' => 'CheckResultTip',
'in' => 'formData',
'schema' => ['description' => '扩展程序对本次扩展点事件进行检查的摘要信息。'."\n"
.'该信息会显示在您当前的开发页面上，当本次检查存在警告或者检查不通过时，您可以通过该摘要信息快速定位原因。', 'type' => 'string', 'required' => false, 'example' => 'Succeeded'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的唯一标识，'."\n"
.'用于后续错误排查使用。', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]',
'title' => '更新扩展点事件的检查结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateMcpServer' => [
'summary' => '更新 MCP Server',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要更新的 MCP Server 名称。'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server'],
],
[
'name' => 'Url',
'in' => 'formData',
'schema' => ['description' => '新的服务地址，需以 `https://` 开头。'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://example.com/mcp/sse'],
],
[
'name' => 'Transport',
'in' => 'formData',
'schema' => [
'description' => '新的传输协议。'."\n",
'type' => 'string',
'required' => false,
'example' => 'SSE',
'enum' => ['STREAMABLE_HTTP', 'SSE'],
],
],
[
'name' => 'CustomHeaders',
'in' => 'formData',
'style' => 'json',
'schema' => ['description' => '新的自定义请求头（键值对）。'."\n", 'type' => 'object', 'required' => false, 'example' => '{}'],
],
[
'name' => 'Visibility',
'in' => 'formData',
'schema' => [
'description' => '新的可见性级别。'."\n",
'type' => 'string',
'required' => false,
'example' => 'TENANT',
'enum' => ['TENANT', 'PROJECT', 'USER'],
],
],
[
'name' => 'VisibilityScope',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '新的可见性范围，按 Visibility 取对应字段。'."\n",
'type' => 'object',
'properties' => [
'ProjectIds' => [
'description' => '可见的项目 ID 列表，Visibility 为 \\`PROJECT\\` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '工作空间ID列表', 'type' => 'string', 'required' => false, 'example' => '[3162, 45766, 61258, 68916, 73279]'],
'required' => false,
],
'UserIds' => [
'description' => '可见的用户 ID 列表，Visibility 为 \\`USER\\` 时生效。'."\n",
'type' => 'array',
'items' => ['description' => '可见的用户 ID', 'type' => 'string', 'required' => false, 'example' => '[123]'],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'],
'McpServer' => [
'description' => '-',
'type' => 'object',
'properties' => [
'Name' => ['description' => '**MCP Server 名称。**'."\n", 'type' => 'string', 'example' => 'my-mcp-server'],
'GmtCreateTime' => ['description' => '创建时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
'GmtModifiedTime' => ['description' => '**最近修改时间（毫秒时间戳）。**'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateMcpServer-更新 MCP Server',
'description' => '## 请求说明'."\n"
.'本API允许用户更新指定MCP Server的相关配置，包括服务地址、传输协议、自定义请求头以及可见性设置等。未提供的字段将保持原有值不变。'."\n"
."\n"
.'**注意**：在修改`Visibility`参数时，请根据其设定选择性地提供`VisibilityScope`中的`ProjectIds`或`UserIds`，以确保正确的访问控制范围被应用。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"McpServer\\": {\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]',
],
'UpdateMetaCollection' => [
'summary' => '更新数据地图集合对象，包括数据地图类目和数据专辑，支持更新集合名称，描述和管理员信息。'."\n"
.'更新数据专辑时，要求调用者具有AliyunDataWorksFullAccess 权限，或者为专辑的创建者或管理员。',
'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' => '集合对象ID', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd'],
],
[
'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' => '集合管理员ID列表，仅专辑类型支持，要求管理员为同租户下账号',
'type' => 'array',
'items' => ['description' => '集合管理员ID', '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' => '更新数据地图集合对象',
'description' => '1. 需要购买DataWorks专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateMetaEntity' => [
'summary' => '更新元数据实体，支持更新创建的自定义类型对象或者扩展表对象（Database/Table/Column）',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => '实体ID', 'description' => '待更新实体 ID；实体名称、实体类型、父子关系由 ID 决定，不支持通过本接口修改', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api:api_001'],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['title' => '注释', 'description' => '注释', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"],
],
[
'name' => 'Attributes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '实体属性，复杂值需要序列化为JSON字符串',
'description' => '实体属性，复杂值需要序列化为JSON字符串',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'string', 'description' => '实体属性值', 'example' => 'value'],
'example' => '[]',
],
],
[
'name' => 'CustomAttributes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '自定义属性值，key为自定义属性标识，value最多一个值；空列表表示删除该属性值',
'description' => '自定义属性值，key为自定义属性标识，value最多一个值；空列表表示删除该属性值',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'title' => '自定义属性值的数组，当前仅支持单值数组',
'description' => '自定义属性值的数组，当前仅支持单值数组',
'type' => 'array',
'items' => ['title' => '自定义属性值', 'type' => 'string', 'example' => '张三', 'description' => '自定义属性值'],
],
'example' => '[]',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'Result' => [
'title' => '更新后的实体或写入结果',
'description' => '更新后的实体或写入结果',
'type' => 'object',
'properties' => [
'Id' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'example' => 'custom_entity-customer_api:api_001'],
'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新元数据实体',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'requestParamsDescription' => '## 纯自定义实体'."\n"
."\n"
.'`EntityType` 使用 `custom_entity-`。可更新内容如下：'."\n"
."\n"
.'| 字段 | 支持情况 | 说明 |'."\n"
.'|------|----------|------|'."\n"
.'| `Comment` | 支持 | 更新实体注释 |'."\n"
.'| `Attributes` | 支持 | key 必须存在于对应 `MetaEntityDef.AttributeDefs`；未知 key 报错 |'."\n"
.'| `CustomAttributes` | 支持 | key 必须是适用于该实体类型的自定义属性定义 |'."\n"
."\n"
.'### Attributes 规则'."\n"
."\n"
.'| 项目 | 说明 |'."\n"
.'|------|------|'."\n"
.'| 更新语义 | patch 语义；只传入的 key 会被更新，其它已有属性保留 |'."\n"
.'| 删除属性 | 传入某个属性 key 且 value 为 `null` 时，会从实体 `attributes` 中删除该 key |'."\n"
.'| 必填属性 | 如果删除或清空的是必填属性，会按合并后的结果校验并报错 |'."\n"
.'| ENUM 属性 | value 必须在 `AttributeDef.AllowedValues` 中 |'."\n"
.'| DATE 属性 | value 必须是毫秒时间戳 |'."\n"
.'| ARRAY/JSON 属性 | 由于 OpenAPI 入参是字符串，通常需要传 JSON 字符串 |'."\n"
."\n"
.'示例：'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Comment": "更新后的自定义实体",'."\n"
.' "Attributes": {'."\n"
.' "level": "L2",'."\n"
.' "profile": "{\\"owner\\":\\"data_team\\"}"'."\n"
.' },'."\n"
.' "CustomAttributes": {'."\n"
.' "biz_owner": ["data_team"]'."\n"
.' }'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'## 扩展表类型的 Database 对象'."\n"
."\n"
.'适用于 `custom_-database`。'."\n"
."\n"
.'| Attributes key | 是否支持 | 类型/写法 | 说明 |'."\n"
.'|----------------|----------|-----------|------|'."\n"
.'| `technicalMetadata.location` | 是 | String | 更新 database 的存储位置，对应 ES 字段 `location` |'."\n"
.'| `parentMetaEntityId` | 否 | - | 父子关系不可更新，传入会报错 |'."\n"
.'| 其它 key | 否 | - | 共享实体更新白名单外的 key 会报错 |'."\n"
."\n"
.'## 扩展表类型 Table对象'."\n"
."\n"
.'适用于 `custom_-table`。'."\n"
."\n"
.'| Attributes key | 是否支持 | 类型/写法 | 说明 |'."\n"
.'|----------------|----------|-----------|------|'."\n"
.'| `tableType` | 是 | String | 更新表类型； |'."\n"
.'| `partitionKeys` | 是 | JSON Array 字符串或 String | 传数组时会用逗号拼接后写入，例如 `["dt","hh"]` 写成 `dt,hh` |'."\n"
.'| `technicalMetadata.owner` | 是 | String | 更新 owner |'."\n"
.'| `technicalMetadata.location` | 是 | String | 更新存储位置 |'."\n"
.'| `technicalMetadata.compressed` | 是 | Boolean | 支持 `true`、`false` |'."\n"
.'| `technicalMetadata.inputFormat` | 是 | String | 更新 InputFormat |'."\n"
.'| `technicalMetadata.outputFormat` | 是 | String | 更新 OutputFormat |'."\n"
.'| `technicalMetadata.serializationLibrary` | 是 | String | 更新 SerDe 类 |'."\n"
.'| `technicalMetadata.parameters` | 是 | JSON Object 字符串或 String | 传 JSON Object 时会序列化为字符串写入 `parameters` |'."\n"
.'| `parentMetaEntityId` | 否 | - | 父 database 不可更新，传入会报错 |'."\n"
.'| `columns` | 否 | - | 不能通过 `UpdateMetaEntity` 改字段列表；需要更新 column 实体本身 |'."\n"
.'| 其它 key | 否 | - | 共享实体更新白名单外的 key 会报错 |'."\n"
."\n"
.'示例：'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Comment": "更新后的表说明",'."\n"
.' "Attributes": {'."\n"
.' "tableType": "VIEW",'."\n"
.' "partitionKeys": "[\\"dt\\"]",'."\n"
.' "technicalMetadata.location": "oss://bucket/ods/order_fact",'."\n"
.' "technicalMetadata.compressed": "true",'."\n"
.' "technicalMetadata.parameters": "{\\"retention\\":\\"30\\"}"'."\n"
.' },'."\n"
.' "CustomAttributes": {'."\n"
.' "biz_owner": ["data_team"]'."\n"
.' }'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'## 扩展表类型的 Column 对象'."\n"
."\n"
.'适用于 `custom_-column`。'."\n"
."\n"
.'| Attributes key | 是否支持 | 类型/写法 | 说明 |'."\n"
.'|----------------|----------|-----------|------|'."\n"
.'| `type` | 是 | String | 更新字段类型 |'."\n"
.'| `position` | 是 | Integer | 更新字段位置 |'."\n"
.'| `partitionKey` | 是 | Boolean | 更新是否分区字段，对应 ES 字段 `isPartitionKey` |'."\n"
.'| `primaryKey` | 是 | Boolean | 更新是否主键，对应 ES 字段 `isPrimaryKey` |'."\n"
.'| `foreignKey` | 是 | Boolean | 更新是否外键，对应 ES 字段 `isForeignKey` |'."\n"
.'| `parentMetaEntityId` | 否 | - | 父 table 不可更新，传入会报错 |'."\n"
.'| 其它 key | 否 | - | 共享实体更新白名单外的 key 会报错 |'."\n"
."\n"
.'如果父表不存在、父表不属于当前租户，或者父表没有 inline columns，会报错。'."\n"
."\n"
.'示例：'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Comment": "订单 ID",'."\n"
.' "Attributes": {'."\n"
.' "type": "BIGINT",'."\n"
.' "position": "1",'."\n"
.' "primaryKey": "true"'."\n"
.' },'."\n"
.' "CustomAttributes": {'."\n"
.' "security_level": ["P1"]'."\n"
.' }'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'## 不支持或容易误用的点'."\n"
."\n"
.'| 项目 | 结论 |'."\n"
.'|------|------|'."\n"
.'| 修改实体名称 | 不支持；名称来自 `Id` |'."\n"
.'| 修改 EntityType | 不支持；类型来自 `Id` |'."\n"
.'| 修改父实体 | 不支持；`attributes.parentMetaEntityId` 会报错 |'."\n"
.'| 修改字段列表 | 不支持；`attributes.columns` 会报错 |'."\n"
.'| 创建新字段 | 不支持；扩展 table 的字段需要在创建 table 时通过 `BatchCreateMetaEntities` 的 `Attributes.columns` 提供 |',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Id\\": \\"custom_entity-customer_api:api_001\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]',
],
'UpdateMetaEntityDef' => [
'summary' => '更新元数据实体定义（包含纯自定义类型和扩展表类型）。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdideX3KVYR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'EntityType',
'in' => 'formData',
'schema' => ['title' => '实体类型，需匹配 `^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$`', 'description' => '实体类型', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['title' => '新的展示名称，最长32个字符', 'description' => '新的展示名称，最长32个字符', 'type' => 'string', 'required' => false, 'example' => 'Business API'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '新的描述', 'description' => '新的描述', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
[
'name' => 'NewAttributeDefs',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '新增属性定义，新增属性必须为可选属性',
'description' => '新增属性定义，新增属性必须为可选属性',
'type' => 'array',
'items' => ['description' => '属性定义', 'required' => false, '$ref' => '#/components/schemas/MetaEntityAttributeDef'],
'required' => false,
'example' => '[]',
'maxItems' => 100,
],
],
[
'name' => 'UpdateAttributeDefs',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '更新已有属性定义，仅支持修改展示名称、描述以及ENUM追加枚举值',
'description' => '更新已有属性定义，仅支持修改展示名称、描述以及ENUM追加枚举值',
'type' => 'array',
'items' => ['description' => '属性定义', 'required' => false, '$ref' => '#/components/schemas/MetaEntityAttributeDef'],
'required' => false,
'example' => '[]',
'maxItems' => 100,
],
],
],
'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' => 'E08F38AB-3BA0-5047-8E9E-9AA4839263EA'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新元数据实体定义',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E08F38AB-3BA0-5047-8E9E-9AA4839263EA\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'UpdateNode' => [
'summary' => '调用此接口，可以更新数据开发节点信息。更新通过增量更新的方式进行，更新的信息通过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' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发节点的唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个节点的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n"
."\n"
.'> 如何快速获取FlowSpec模板？'."\n"
.'> - 在数据开发中打开节点->点击右侧版本->查看最新版本->查看调度配置，即可得到针对当前节点的FlowSpec描述。可以基于版本中的FlowSpec描述快速构建符合要求的模板。'."\n"
."\n"
.'> 节点的内容如何填写？'."\n"
.'> - 节点的内容填写到$.spec.nodes[*].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"
.' },'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPI_Test/odpsSQL_Test",'."\n"
.' "runtime": {'."\n"
.' "command": "ODPS_SQL"'."\n"
.' },'."\n"
.' "content": "select now();"'."\n"
.' },'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "cron": "00 00 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "runtimeResource": {'."\n"
.' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n"
.' },'."\n"
.' "name": "odpsSQL_Test",'."\n"
.' "inputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "project_root",'."\n"
.' "artifactType": "NodeOutput"'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "output_data",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "odpsSQL_Test"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' }'."\n"
.' ],'."\n"
.' "flow": ['."\n"
.' {'."\n"
.' "nodeId": "860438872620113XXXX",'."\n"
.' "depends": ['."\n"
.' {'."\n"
.' "type": "Normal",'."\n"
.' "output": "project_root"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', 'type' => 'string', 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31****'],
'Success' => ['description' => '调用是否成功。'."\n"
."\n"
.'- true：调用成功'."\n"
."\n"
.'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新数据开发节点信息',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateParameter' => [
'summary' => '更新参数。增量修改，只修改指定的字段。',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREdide7WF1GB'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '参数ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'],
],
[
'name' => 'Properties',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '参数值配置，生产环境必填。如果数组中出现了重复的环境配置，则后出现的配置不生效。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EnvType' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'example' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
'Value' => ['description' => '参数值。', 'type' => 'string', 'required' => false, 'example' => 'value123'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '责任人的账号 ID。', 'type' => 'string', 'required' => false, 'example' => '123456789'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => 'This is a test parameter.'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Version' => ['title' => '版本号', 'description' => '更新后的版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新参数',
'description' => '需要购买 DataWorks 专业版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Version\\": 2,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]',
],
'UpdateProcessDefinition' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244492',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '流程定义ID'."\n", 'type' => 'string', 'required' => true, 'example' => '177554881536128'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '流程定义名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'MaxCompute 表审批'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '流程定义描述'."\n", 'type' => 'string', 'required' => false, 'example' => 'lwt_ide_simple 项目 MaxCompute 表审批策略'],
],
[
'name' => 'RuleConditions',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '条件规则列表。注意：系统策略不生效。',
'type' => 'array',
'items' => [
'description' => '条件规则',
'type' => 'object',
'properties' => [
'Type' => ['description' => '条件类型，枚举：'."\n"
."\n"
.'- `odpsProject`, '."\n"
.'- `hologresInstanceId`'."\n"
.'- `sensibleLevel`, '."\n"
.'- `tableGuid`, '."\n"
.'- `projectId`', 'type' => 'string', 'required' => false, 'example' => 'odpsProject'],
'Scope' => ['description' => '规则生效阶段：'."\n"
.'- **Deployment** 用于判定"提交申请时是否匹配该审批策略'."\n"
.'- **Running** 用于审批流程执行判定是否免审批【仅支持MaxCompute类型】'."\n", 'type' => 'string', 'required' => false, 'example' => 'Deployment'],
'Expression' => ['description' => '条件表达式((#type==\'typeValue\')).如 ((#odpsProject==\'PX_BEIJING_TEST\'))', 'type' => 'string', 'required' => false, 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'NotificationServices',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '通知服务声明',
'type' => 'array',
'items' => [
'description' => '通知服务',
'type' => 'object',
'properties' => [
'Channel' => ['description' => '通知渠道，枚举'."\n"
."\n"
.'- Mail'."\n"
.'- Sms'."\n"
.'- DingRobot'."\n"
.'- Weixin', 'type' => 'string', 'required' => false, 'example' => 'Mail'],
'Extension' => ['description' => '扩展信息，JSON 格式，如 {"atAll":"true"} 声明是否@所有人', 'type' => 'string', 'required' => false, 'example' => '{"atAll":"true"}'],
'Receiver' => ['description' => 'Channel 为DingRobot/Weixin时需指定 WebhookUrl'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://dingtalk.com'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'ApprovalNodes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '审批节点列表。注意：系统策略不生效。',
'type' => 'array',
'items' => [
'description' => '审批节点',
'type' => 'object',
'properties' => [
'Name' => ['description' => '节点名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'default-name'],
'AccountType' => ['description' => '节点审批人类型：'."\n"
.'- DataWorksProjectRole 空间角色'."\n"
.'- DataWorksProjectMember 空间成员'."\n"
.'- TableAdministrator 表负责人'."\n"
.'- TableOrProjectAdministrator 表或空间管理员'."\n"
.'- AliyunResourceOwner 阿里云账号'."\n"
.'- MaxComputeRole MC管理员'."\n"
.'- DLFAdmin DlfLegacy管理员'."\n"
.'- DLFNextAdmin DLFNext管理员'."\n"
.'- TenantRole 租户角色'."\n"
.'- EmrAdministrator Emr管理员'."\n"
.'- LindormAdministrator Lindorm管理员'."\n"
.'- AliyunRamUser RAM子账号'."\n", 'type' => 'string', 'required' => false, 'example' => 'TableOrProjectAdministrator'],
'Assignees' => ['description' => '当AccountType为不同类型，对应不同语义：'."\n"
.'- DataWorksProjectMember声明空间成员UserId'."\n"
.'- DataWorksProjectRole声明空间角色code'."\n"
.'- MaxComputeRole声明MC的角色'."\n"
.'- TenantRole声明租户角色code'."\n"
.'- AliyunRamUser声明RAM userId'."\n", 'type' => 'string', 'required' => false, 'example' => 'DataWorksProjectMember'],
'ExtensionProperties' => [
'description' => '当 `AccountType ` 为不同类型，需要提供不同额外声明：'."\n"
."\n"
.'- `DataWorksProjectMember`: key 为 projectId, value 为空间成员 UserId，多个使用逗号分割'."\n"
.'- `MaxComputeRole`: key 为 MaxCompute 的 project, value 为 MC 中 role name，多个使用逗号分割',
'type' => 'object',
'required' => false,
'additionalProperties' => ['type' => 'any', 'example' => '{'."\n"
.' "449656": "role_project_admin,role_project_pe"'."\n"
.' }', 'description' => '扩展说明'],
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等参数。用于避免多次调用导致操作重复。', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'API 请求响应错误码，调用出错时非空'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API 请求 ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新审批流程定义',
'summary' => '用于更新已有的审批流程定义信息。',
'description' => '## 请求说明'."\n"
.'- 该接口允许用户修改现有的审批流程定义，包括名称、描述、规则条件、通知服务和审批节点等。'."\n"
.'- `Id` 是必须提供的参数，用来指定要更新的审批流程定义。'."\n"
.'- 如果需要覆盖现有配置，请设置 `Overwrite` 参数为 `true`。'."\n"
.'- `ClientToken` 可选，用于保证请求的幂等性。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\"\\n}","type":"json"}]',
],
'UpdateProject' => [
'summary' => '该接口用于更新DataWorks工作空间。',
'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' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n"
."\n"
.'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '工作空间描述.', 'type' => 'string', 'required' => false, 'example' => 'Financial analysis group project data development'],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '禁用/解禁工作空间：'."\n"
."\n"
.'- Available 解除禁用'."\n"
."\n"
.'- Forbidden 空间禁用',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Forbidden',
'enum' => ['Forbidden', 'Available'],
],
],
[
'name' => 'DevEnvironmentEnabled',
'in' => 'formData',
'schema' => ['description' => '是否启用开发环境：'."\n"
."\n"
.'- true：工作空间启用开发环境，支持开发与生产环境隔离'."\n"
."\n"
.'- false：仅使用生产环境'."\n"
."\n"
.'注意：启用开发环境后（即开发与生产环境隔离），不支持禁用开发环境。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DevRoleDisabled',
'in' => 'formData',
'schema' => ['description' => '是否禁用开发角色：'."\n"
."\n"
.'- false，开启开发角色（默认）'."\n"
."\n"
.'- true，禁用开发角色'."\n"
."\n"
.'注意：启用开发角色（即允许工作流程和代码编辑功能）后，不支持禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => '工作空间展示名称。', 'type' => 'string', 'required' => false, 'example' => 'Sora financial analysis Space'],
],
[
'name' => 'PaiTaskEnabled',
'in' => 'formData',
'schema' => ['description' => '是否启用PAI任务调度：'."\n"
."\n"
.'- true 可以在DataWorks工作空间创建机器学习（PAI）节点，并按照节点配置进行周期性调度运行。'."\n"
."\n"
.'- false 禁用PAI任务调度。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。用于定位日志，排查问题。', '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' => '更新工作空间',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'UpdateProjectRole' => [
'summary' => '更新空间自定义角色权限',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244504',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['description' => 'DataWorks 工作空间的 ID。您可以登录 [DataWorks 控制台](https://dataworks.console.aliyun.com/workspace/list)，进入工作空间管理页面获取 ID。'."\n"
."\n"
.'该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '234'],
],
[
'name' => 'Code',
'in' => 'query',
'schema' => ['description' => '自定义角色唯一标识', 'type' => 'string', 'required' => true, 'example' => 'base_role_xx'],
],
[
'name' => 'ModulePermissions',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Dataworks 模块权限列表',
'type' => 'array',
'items' => [
'description' => 'Dataworks 模块权限',
'type' => 'object',
'properties' => [
'ModuleId' => [
'title' => '2: HoloStudio'."\n"
.'3: StreamStudio'."\n"
.'4: 发布管理'."\n"
.'6: 数据保护伞'."\n"
.'7: 数据地图'."\n"
.'8: 数据服务'."\n"
.'9: 数据集成'."\n"
.'10: 数据建模（DataBlau DDM）'."\n"
.'11: 数据开发'."\n"
.'12: 数据质量'."\n"
.'13: 数据综合治理'."\n"
.'14: 运维中心'."\n"
.'15: 资源优化'."\n"
.'16: 迁移助手'."\n"
.'17: 数据分析'."\n"
.'18: 审批中心'."\n"
.'19: 安全中心'."\n"
.'20: 智能数据建模'."\n",
'description' => 'Dataworks模块ID如下：'."\n"
.'- 2: HoloStudio'."\n"
.'- 3: StreamStudio'."\n"
.'- 4: 发布管理'."\n"
.'- 6: 数据保护伞'."\n"
.'- 7: 数据地图'."\n"
.'- 8: 数据服务'."\n"
.'- 9: 数据集成'."\n"
.'- 10: 数据建模（DataBlau DDM）'."\n"
.'- 11: 数据开发'."\n"
.'- 12: 数据质量'."\n"
.'- 13: 数据综合治理'."\n"
.'- 14: 运维中心'."\n"
.'- 15: 资源优化'."\n"
.'- 16: 迁移助手'."\n"
.'- 17: 数据分析'."\n"
.'- 18: 审批中心'."\n"
.'- 19: 安全中心'."\n"
.'- 20: 智能数据建模',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => ['Write' => 'Write', 'Read' => 'Read', 'NotSet' => 'NotSet'],
'example' => '2',
],
'PermissionType' => ['description' => '权限类型。取值如下：'."\n"
.'- Write：只读'."\n"
.'- Read：编辑'."\n"
.'- NotSet：未控制', 'type' => 'string', 'required' => false, 'example' => 'Write'],
],
'required' => false,
],
'required' => true,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '保留字段。', 'type' => 'string', 'required' => false, 'example' => '0000-ABCD-EFG****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求的 ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '037DFCE4-ABA5-51D7-9F2D-CCF709252DAA'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新工作空间自定义角色',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"037DFCE4-ABA5-51D7-9F2D-CCF709252DAA\\"\\n}","type":"json"}]',
],
'UpdateResource' => [
'summary' => '调用此接口，可以更新数据开发文件资源的基本信息。更新以增量更新的方式进行，更新信息以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' => 'DataWorks工作空间的ID。您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间配置页面获取工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发文件资源唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '543217824470354XXXX'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个数据开发文件资源的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md)。', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "version": "1.1.0",'."\n"
.' "kind": "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' => '资源包含的具体的文件流或OSS下载链接。'."\n"
.'>该字段允许用户填写文件流或OSS下载链接。当填写OSS下载链接时，请确保该OSS链接可被公开访问。推荐提供预签名URL。>', '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',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。用于出现错误后排查问题。', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA81****'],
'Success' => ['description' => '调用是否成功。取值如下：'."\n"
.'- true：调用成功。'."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新数据开发文件资源信息',
'changeSet' => [
['createdAt' => '2025-05-06T02:37:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'UpdateResourceGroup' => [
'summary' => '更新资源组基本信息。',
'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' => '通用资源组唯一标识。', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '要修改的通用资源组的名称', 'description' => '要修改的通用资源组的名称。', 'type' => 'string', 'required' => false, 'example' => 'common_resource_group'],
],
[
'name' => 'Remark',
'in' => 'formData',
'schema' => ['title' => '要修改的通用资源组的备注', 'description' => '要修改的通用资源组的备注。', 'type' => 'string', 'required' => false, 'example' => 'Create a common resource group for common tasks'],
],
[
'name' => 'AliyunResourceGroupId',
'in' => 'formData',
'schema' => ['title' => '阿里云资源组ID', 'description' => '要修改的所属阿里云资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2kqofrg****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题。', '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' => '更新资源组基本信息',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
],
],
],
],
],
'UpdateRoute' => [
'summary' => '更新路由信息。',
'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' => '网络资源的路由ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000'],
],
[
'name' => 'DestinationCidr',
'in' => 'formData',
'schema' => [
'title' => '更新的路由目的的CIDR',
'description' => '更新的路由目的的CIDR',
'type' => 'string',
'required' => true,
'example' => '192.168.0.0/16',
'enum' => [],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Success' => ['title' => '是否请求成功', 'description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
'RequestId' => ['title' => '请求的ID，用于定位日志，排查问题', 'description' => '请求的ID，用于定位日志，排查问题', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]',
'title' => '更新路由信息',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateSecurityStrategy' => [
'summary' => '用于修改现有安全策略的配置信息。需要Dataworks 租户管理员与安全管理员权限。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => 'TBD',
'abilityTreeNodes' => ['FEATUREdideYTM537'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '**策略ID**', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '**策略名称**', 'type' => 'string', 'required' => false, 'example' => '默认数据分析策略'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '**策略描述**', 'type' => 'string', 'required' => false, 'example' => '控制数据分析模块的查询结果安全行为'],
],
[
'name' => 'Workspaces',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '**关联工作空间ID列表**',
'type' => 'array',
'items' => ['description' => '工作空间ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12343'],
'required' => false,
],
],
[
'name' => 'Content',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '策略内容。内容受 SecurityStrategySchema 约束',
'type' => 'object',
'properties' => [
'Controllers' => [
'description' => '管控项列表，'."\n"
."\n"
.'注意：合法管控项取决于所选 Schema，参考 Controller定义 及 各Schema管控项列表',
'type' => 'array',
'items' => [
'description' => '管控项列表。',
'type' => 'object',
'properties' => [
'Controller' => ['description' => '管控项标识符，取值见 各Schema管控项列表'."\n", 'type' => 'string', 'required' => false, 'example' => 'viewCount'],
'DisplayName' => ['description' => '显示名称'."\n", 'type' => 'string', 'required' => false, 'example' => '查询结果-单次展示记录值上限'],
'DisplayNameEn' => ['description' => '英文显示名称'."\n", 'type' => 'string', 'required' => false, 'example' => 'Query Results - Single Display Record Limit'],
'Enable' => ['description' => '是否启用该管控项'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'ControllerValueType' => ['description' => '控制器值类型（Boolean/Integer/Long/String）'."\n", 'type' => 'string', 'required' => false, 'example' => 'Integer'],
'UserConfigValue' => ['description' => '用户配置值，类型取决于ControllerValueType'."\n", 'type' => 'any', 'required' => false, 'example' => '20'],
'BasicEditionDefaultValue' => ['description' => '基础版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '10000'],
'StandardEditionDefaultValue' => ['description' => '标准版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '10000'],
'ProfessionalEditionDefaultValue' => ['description' => '专业版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '10000'],
'EnterpriseEditionDefaultValue' => ['description' => '企业版默认值'."\n", 'type' => 'any', 'required' => false, 'example' => '10000'],
'BasicEditionIntervalValue' => [
'description' => '基础版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'required' => false,
],
'StandardEditionIntervalValue' => [
'description' => '标准版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'required' => false,
],
'ProfessionalEditionIntervalValue' => [
'description' => '专业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'required' => false,
],
'EnterpriseEditionIntervalValue' => [
'description' => '企业版有效值区间[min, max]'."\n",
'type' => 'array',
'items' => ['description' => '区间起止值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'required' => false,
],
],
'required' => false,
],
'required' => true,
'minItems' => 1,
],
],
'required' => true,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => '幂等参数。用于避免多次调用导致操作重复。', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9*****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'API请求响应错误码，调用出错时非空'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'API请求ID'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新安全策略',
'description' => '## 请求说明'."\n"
.'- 本接口允许用户更新指定的安全策略，包括但不限于策略名称、描述、关联的工作空间ID列表以及策略内容等。'."\n"
.'- 系统默认策略的部分属性（如Schema名称、管控模块等）不允许被修改。'."\n"
.'- 当`ControlDwScope`设置为`Workspace`时，可以指定`Workspaces`参数来关联特定的工作空间。'."\n"
.'- 更新策略内容(`Content`)时，请确保提供的控制器(`Controllers`)符合所选Schema的要求。'."\n"
.'- `ClientToken`参数可选，用于保证请求的幂等性。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]',
],
'UpdateTableBusinessMetadata' => [
'summary' => '更新数据地图数据表的业务元数据，当前仅支持更新表的使用说明和自定义属性。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '267996',
'abilityTreeNodes' => ['FEATUREdideE9XYA6'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['title' => '数据表ID', 'description' => '数据表ID，格式可参考ListTables接口返回结果。', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'],
],
[
'name' => 'Readme',
'in' => 'formData',
'schema' => ['title' => '使用说明。不传Readme且不传CustomAttributes时，仅传Id会兼容旧行为清空使用说明；如果只更新自定义属性且不希望影响使用说明，请传CustomAttributes', 'description' => '使用说明，支持富文本格式。', 'type' => 'string', 'required' => false, 'example' => '## introduction'],
],
[
'name' => 'CustomAttributes',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '自定义属性值，key为自定义属性标识，value最多一个值；空列表表示删除该属性值。不传Readme时传入本参数可避免清空使用说明；传空对象表示不更新自定义属性',
'description' => '自定义属性值，key为自定义属性标识，value最多一个值；空列表表示删除该属性值。不传Readme时传入本参数可避免清空使用说明；传空对象表示不更新自定义属性',
'type' => 'object',
'required' => false,
'additionalProperties' => [
'title' => '自定义属性值的数组，当前仅支持单值数组',
'description' => '自定义属性值的数组，当前仅支持单值数组',
'type' => 'array',
'items' => ['title' => '自定义属性值', 'type' => 'string', 'example' => '张三', 'description' => '属性值'],
],
'example' => '{"biz_owner":["张三"]}',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7C352CB7-CD88-XXXXXXX'],
'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-XXXXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新数据地图数据表的业务元数据',
'description' => '1. 需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateTask' => [
'summary' => '更新指定任务。修改的内容会同步到数据开发，数据开发将新增一个保存版本。',
'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' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'ClientUniqueCode',
'in' => 'formData',
'schema' => ['description' => '任务的客户端唯一码，用来唯一标识一个任务。用于实现异步和幂等，创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', 'type' => 'string', 'required' => false, 'example' => 'Task_0bc5213917368545132902xxxxxxxx'],
],
[
'name' => 'EnvType',
'in' => 'formData',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod', 'Dev'],
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '名称。', 'type' => 'string', 'required' => false, 'example' => 'SQL node'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '任务的责任人的账号ID。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
[
'name' => 'InstanceMode',
'in' => 'formData',
'schema' => [
'description' => '实例生成模式。'."\n"
.'- T+1（第二天生成）'."\n"
.'- Immediately（立即生成）。注意：节点定时时间在节点发布时间点十分钟后的周期实例才会正常生成。全量转实例期间（22:00~24:00点期间）不能进行实时转实例，可以提交发布节点，但新增节点不会自动转出实例。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'T+1',
'default' => 'T+1',
'enum' => ['T+1', 'Immediately'],
],
],
[
'name' => 'Timeout',
'in' => 'formData',
'schema' => ['description' => '任务执行超时时间，单位秒。取值应大于3600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
],
[
'name' => 'RerunMode',
'in' => 'formData',
'schema' => [
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'AllAllowed',
'enum' => ['AllAllowed', 'FailureAllowed', 'AllDenied'],
],
],
[
'name' => 'RerunTimes',
'in' => 'formData',
'schema' => ['description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'RerunInterval',
'in' => 'formData',
'schema' => ['description' => '重试时间间隔，单位毫秒。（不得超过1800000）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60000'],
],
[
'name' => 'Script',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '运行脚本信息。',
'type' => 'object',
'properties' => [
'Content' => ['description' => '脚本内容。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'echo "helloWorld"'],
'Parameters' => ['description' => '脚本参数列表。', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate'],
],
'required' => false,
],
],
[
'name' => 'Trigger',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'title' => '`Scheduler` 周期触发',
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Scheduler',
'enum' => ['Scheduler', 'Manual'],
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'Skip', 'Pause'],
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'required' => false, 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '9999-01-01 00:00:00'],
'CycleType' => [
'description' => '周期类型，Type=Scheduler 且 Cron表达式为指定某小时定时调度时生效。默认为Daily。'."\n"
.'- Daily：指定为天调度'."\n"
.'- NotDaily：指定为小时调度',
'type' => 'string',
'required' => false,
'example' => 'Daily',
'enum' => ['Daily', 'NotDaily'],
],
],
'required' => false,
],
],
[
'name' => 'RuntimeResource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'required' => false, 'example' => '0.25'],
],
'required' => false,
],
],
[
'name' => 'DataSource',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'required' => false, 'example' => 'odps_test'],
],
'required' => false,
],
],
[
'name' => 'Inputs',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '输入信息。',
'type' => 'object',
'properties' => [
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Constant',
'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'],
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
'Name' => ['description' => '变量名称。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'Outputs',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '输出信息。',
'type' => 'object',
'properties' => [
'TaskOutputs' => [
'description' => '任务输出定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Output' => ['title' => '输出标识符，示例：pre.odps_sql_demo_0', 'description' => '输出标识符。', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'Variables' => [
'description' => '变量定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Constant',
'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'],
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
'Name' => ['description' => '变量名称。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'Dependencies',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '依赖信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '依赖类型',
'description' => '依赖类型。'."\n"
.'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n"
.'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n"
.'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n"
.'- Normal：同周期依赖',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'CrossCycleDependsOnSelf', 'CrossCycleDependsOnChildren', 'CrossCycleDependsOnOtherNode'],
],
'UpstreamOutput' => ['title' => '依赖任务的输出标识符,或者任务ID', 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'],
'UpstreamTaskId' => ['description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'Tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => '更新任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'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' => '任务实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
'Priority' => [
'description' => '实例运行优先级，取值分为1、3、5、7和8。'."\n"
."\n"
.'取值越大，优先级越高。默认优先级为1。',
'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' => '资源组信息，这里请填入调度资源组标识符。', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'DataSource' => [
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'required' => false, 'example' => 'mysql_test'."\n"],
],
'required' => false,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'Comment',
'in' => 'formData',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"],
'SuccessInfo' => [
'description' => '批量操作的结果信息。结构为Map，以任务实例ID为键，以结果信息为Value。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'Success' => ['type' => 'boolean', 'description' => '操作是否成功。', 'example' => 'true'],
'Message' => ['type' => 'string', 'example' => '该实例不存在。', 'description' => '错误信息。'],
],
'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' => '修改任务实例属性',
'summary' => '批量修改多个任务实例的属性，包括优先级、调度资源组、数据源等。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '函数文件所在文件夹的路径'."\n"
.'。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/First_Business_Process/function/string_processing_function'],
],
[
'name' => 'ProjectId',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的ID，'."\n"
.'您可以单击页面右上角的小扳手图标，进入工作空间管理页面查看。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'],
],
[
'name' => 'FunctionType',
'in' => 'formData',
'schema' => [
'description' => '函数的分类，'."\n"
.'对应创建函数表单中的函数类型，包括MATH（数学运算函数）、AGGREGATE（聚合函数）、STRING（字符串处理函数）、DATE（日期处理函数）、ANALYTIC（窗口函数）和OTHER（其他函数）。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'STRING',
'enum' => ['MATH', 'AGGREGATE', 'STRING', 'DATE', 'ANALYTIC', 'OTHER'],
],
],
[
'name' => 'ClassName',
'in' => 'formData',
'schema' => ['description' => '函数定义所在的类名，'."\n"
.'对应创建函数表单的类名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat'],
],
[
'name' => 'Resources',
'in' => 'formData',
'schema' => ['description' => '函数引用的资源名列表，'."\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' => '函数用途的说明，'."\n"
.'对应创建函数表单中的描述。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Concatenate several strings to generate a new string'],
],
[
'name' => 'CmdDescription',
'in' => 'formData',
'schema' => ['description' => '函数的调用命令格式，'."\n"
.'对应创建函数表单中的命令格式。', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(String... substrs)'],
],
[
'name' => 'ParameterDescription',
'in' => 'formData',
'schema' => [
'description' => '函数入参的说明，'."\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' => '函数的返回值说明，'."\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' => '函数的调用示例，'."\n"
.'对应创建函数表单中的示例。', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(\'a\', \'b\', \'c\')'],
],
[
'name' => 'ProjectIdentifier',
'in' => 'formData',
'schema' => ['description' => 'DataWorks工作空间的唯一标识符，'."\n"
.'即数据开发页面顶部切换工作空间处的英文标识。'."\n"
."\n"
.'该参数与ProjectId参数二者必须设置其一，以确定本次API调用操作的DataWorks工作空间。', 'type' => 'string', 'required' => false, 'example' => 'dw_project'],
],
[
'name' => 'FileId',
'in' => 'formData',
'schema' => ['description' => '文件的'."\n"
.'ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000001'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果'."\n"
.'。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'HTTP状态码'."\n"
.'。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'ErrorMessage' => ['description' => '错误消息'."\n"
.'。', 'type' => 'string', 'example' => 'The connection does not exist.'],
'RequestId' => ['description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题'."\n"
.'。', 'type' => 'string', 'example' => '0000-ABCD-EFG****'],
'ErrorCode' => ['description' => '错误码'."\n"
.'。', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'],
'Success' => ['description' => '请求是否成功：'."\n"
."\n"
.'- true（成功）'."\n"
.'- false（失败）', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => '没有权限，请授权'],
],
429 => [
['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''],
['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''],
['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新函数的文件信息',
'summary' => '调用UpdateUdfFile更新函数的文件信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => '工作流ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'],
],
[
'name' => 'EnvType',
'in' => 'formData',
'schema' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Prod',
'default' => 'Prod',
'enum' => ['Prod'],
],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '名称。', 'type' => 'string', 'required' => true, 'example' => 'My Workflow'],
],
[
'name' => 'Owner',
'in' => 'formData',
'schema' => ['description' => '责任人的账号ID。', 'type' => 'string', 'required' => true, 'example' => '1000'],
],
[
'name' => 'Trigger',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Scheduler',
'enum' => ['Scheduler', 'Manual'],
],
'Cron' => ['description' => 'Cron表达式，type=Scheduler时生效。', 'type' => 'string', 'required' => false, 'example' => '00 00 00 * * ?'],
'StartTime' => ['description' => '周期触发生效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '1970-01-01 00:00:00'],
'EndTime' => ['description' => '周期触发失效时间，type=Scheduler时生效。格式为`yyyy-mm-dd hh:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '9999-01-01 00:00:00'],
],
'required' => true,
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Dependencies',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '依赖信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '依赖类型',
'description' => '依赖类型。'."\n"
.'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n"
.'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n"
.'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n"
.'- Normal：同周期依赖',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'CrossCycleDependsOnSelf', 'CrossCycleDependsOnChildren', 'CrossCycleDependsOnOtherNode'],
],
'UpstreamOutput' => ['title' => '依赖任务的输出标识符,或者任务ID', 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'],
'UpstreamTaskId' => ['description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'Parameters',
'in' => 'formData',
'schema' => ['description' => '参数列表。', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate para2=$[yyyymmdd] '],
],
[
'name' => 'Tasks',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => '任务ID。填写此字段会对相应任务执行全量更新，未填写此字段则会创建新任务。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'Name' => ['description' => '任务的名称。', 'type' => 'string', 'required' => true, 'example' => 'SQL node'],
'Description' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Test'],
'Type' => ['description' => '任务类型。', 'type' => 'string', 'required' => true, 'example' => 'ODPS_SQL'],
'Owner' => ['description' => '责任人的账号ID。', 'type' => 'string', 'required' => true, 'example' => '1000'],
'BaseLineId' => ['description' => '基线ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
'Timeout' => ['description' => '任务执行超时时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
'RerunMode' => [
'description' => '任务是否允许重跑的配置。'."\n"
.'- AllDenied：失败或成功都不可重跑'."\n"
.'- FailureAllowed：只有失败可重跑'."\n"
.'- AllAllowed：失败或成功均可重跑',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'AllAllowed',
'enum' => ['AllAllowed', 'FailureAllowed', 'AllDenied'],
],
'RerunTimes' => ['description' => '重试次数，当任务设置为可重跑时生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
'RerunInterval' => ['description' => '重试时间间隔，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
'Script' => [
'description' => '运行脚本信息。',
'type' => 'object',
'properties' => [
'Content' => ['description' => '脚本内容。', 'type' => 'string', 'required' => false, 'example' => 'echo "helloWorld"'],
'Parameters' => ['description' => '脚本参数列表。', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate'],
],
'required' => false,
],
'Trigger' => [
'description' => '任务触发方式。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '触发方式类型。'."\n"
.'- Scheduler：调度周期触发'."\n"
.'- Manual：手动触发',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Scheduler',
'default' => 'Scheduler',
'enum' => ['Scheduler', 'Manual'],
],
'Recurrence' => [
'description' => '触发时的运行模式，type=Scheduler时生效。'."\n"
.'- Pause：暂停'."\n"
.'- Skip：空跑'."\n"
.'- Normal：正常运行',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'Skip', 'Pause'],
],
],
'required' => true,
],
'RuntimeResource' => [
'description' => '运行环境配置，如资源组信息。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '任务运行配置的调度资源组标识符。', 'type' => 'string', 'required' => true, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'],
'Image' => ['description' => '任务运行配置的镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx'],
'Cu' => ['description' => '任务运行配置CU消耗。', 'type' => 'string', 'required' => false, 'example' => '0.25'],
],
'required' => true,
],
'DataSource' => [
'description' => '关联数据源信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '数据源名称。', 'type' => 'string', 'required' => false, 'example' => 'odps_test'],
],
'required' => false,
],
'Inputs' => [
'description' => '输入信息。注意，此字段为空时将默认删除所有Inputs配置。',
'type' => 'object',
'properties' => [
'Variables' => [
'description' => '变量定义列表。注意，此字段未填或为空数组时将默认删除所有Inputs.Variables配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '变量名称。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Constant',
'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'],
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'required' => false,
],
'Outputs' => [
'description' => '输出信息。注意，此字段为空时将默认删除所有Outputs配置。',
'type' => 'object',
'properties' => [
'TaskOutputs' => [
'description' => '任务输出定义列表。注意，此字段未填或为空数组时将默认删除所有TaskOutputs配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Output' => ['title' => '输出标识符，示例：pre.odps_sql_demo_0', 'description' => '输出标识符。', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'Variables' => [
'description' => '变量定义列表。注意，此字段未填或为空数组时将默认删除所有Outputs.Variables配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '变量名。', 'type' => 'string', 'required' => false, 'example' => 'key1'],
'Type' => [
'title' => '类型',
'description' => '类型。'."\n"
.'- Constant：常量'."\n"
.'- PassThrough：参数节点输出'."\n"
.'- System：变量'."\n"
.'- NodeOutput：脚本输出',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Constant',
'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'],
],
'Value' => ['description' => '变量值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
'required' => false,
],
'Dependencies' => [
'description' => '依赖信息。注意，此字段未填或为空数组时将默认删除所有Dependencies配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'title' => '依赖类型',
'description' => '依赖类型。'."\n"
.'- CrossCycleDependsOnChildren：跨周期依赖一级子节点'."\n"
.'- CrossCycleDependsOnSelf：跨周期依赖自己'."\n"
.'- CrossCycleDependsOnOtherNode：跨周期依赖其他节点'."\n"
.'- Normal：同周期依赖',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'Normal',
'enum' => ['Normal', 'CrossCycleDependsOnSelf', 'CrossCycleDependsOnChildren', 'CrossCycleDependsOnOtherNode'],
],
'UpstreamOutput' => ['title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', 'description' => '上游任务的输出标识符。（`同周期依赖`且设置input内容时，返回此字段）', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'],
'UpstreamTaskId' => ['title' => '依赖任务的任务ID, DependencyType=CrossCycleDependsOnOtherNode时 需要填此值', 'description' => '上游任务的Id。（`跨周期依赖其他节点`与`同周期依赖`未设置input内容时，返回此字段，其他情况不返回）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'Tags' => [
'description' => '任务标签列表。注意，此字段未填或为空数组时将默认删除所有Tags配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
'ClientUniqueCode' => ['description' => '任务的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', 'type' => 'string', 'required' => false, 'example' => 'Task_0bc5213917368545132902xxxxxxxx'],
'EnvType' => [
'description' => '项目环境。'."\n"
.'- Prod：生产'."\n"
.'- Dev：开发',
'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' => '输出信息。',
'type' => 'object',
'properties' => [
'TaskOutputs' => [
'description' => '工作流任务输出定义列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Output' => ['title' => '输出标识符，示例：pre.odps_sql_demo_0', 'description' => '输出标识符。', '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' => '工作流标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => true, 'example' => 'key1'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value1'],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'ClientUniqueCode',
'in' => 'formData',
'schema' => ['description' => '工作流的客户端唯一码，用于实现异步和幂等。创建时如果不指定，系统将自动生成，该代码将与资源ID进行唯一绑定。更新、删除资源时如果指定该参数，应与创建时的客户端唯一码保持统一。', 'type' => 'string', 'required' => false, 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx'],
],
[
'name' => 'InstanceMode',
'in' => 'formData',
'schema' => [
'description' => '实例生成模式。'."\n"
."\n"
.'- T+1（第二天生成）'."\n"
.'- Immediately（立即生成）。注意：工作流定时时间在工作流发布时间点十分钟后的周期实例才会正常生成。全量转实例期间（22:00~24:00点期间）不能进行实时转实例，可以提交发布工作流，但提交后不会重新生成实例。',
'type' => 'string',
'required' => false,
'example' => 'T+1',
'default' => 'T+1',
'enum' => ['T+1', 'Immediately'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID，用于定位日志，排查问题。', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'],
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新工作流',
'summary' => '以全量更新的方式，更新指定工作流。支持同步更新到数据开发的字段：责任人、数据源、调度资源组、描述信息、触发运行模式（正常、空跑、暂停）。',
'description' => '需要购买DataWorks基础版及以上版本才能使用。',
'changeSet' => [
['createdAt' => '2025-05-15T07:08:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-31T03:56:33.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UpdateWorkflowDefinition' => [
'summary' => '调用此接口，可以更新数据开发工作流基本信息。更新以增量更新的方式进行，更新信息以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' => 'DataWorks工作空间的ID，您可以登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入工作空间管理页面查看ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'],
],
[
'name' => 'Id',
'in' => 'formData',
'schema' => ['description' => '数据开发工作流唯一标识符。'."\n"
."\n"
.'>该字段在SDK8.0.0版本之前为Long类型，SDK8.0.0版本及之后为String类型。**该变更不影响SDK正常使用，参数仍会按SDK中定义的类型返回**。只有在跨8.0.0版本的SDK升级时，类型变更可能会导致项目编译不通过，需要用户手动修正数据类型。>', 'type' => 'string', 'required' => true, 'example' => '652567824470354XXXX'],
],
[
'name' => 'Spec',
'in' => 'formData',
'schema' => ['description' => '描述这个工作流的FlowSpec信息，具体规范详见[FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow)。'."\n"
."\n"
.'>该接口只支持更新Workflow自身的信息，FlowSpec描述的内部节点信息不会被更新。>', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "kind": "CycleWorkflow",'."\n"
.' "version": "1.1.0",'."\n"
.' "spec": {'."\n"
.' "workflows": ['."\n"
.' {'."\n"
.' "id": "652567824470354XXXX",'."\n"
.' "script": {'."\n"
.' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n"
.' "runtime": {'."\n"
.' "command": "WORKFLOW"'."\n"
.' }'."\n"
.' },'."\n"
.' "trigger": {'."\n"
.' "type": "Scheduler",'."\n"
.' "cron": "00 02 00 * * ?",'."\n"
.' "startTime": "1970-01-01 00:00:00",'."\n"
.' "endTime": "9999-01-01 00:00:00",'."\n"
.' "timezone": "Asia/Shanghai",'."\n"
.' "delaySeconds": 0'."\n"
.' },'."\n"
.' "strategy": {'."\n"
.' "timeout": 0,'."\n"
.' "instanceMode": "T+1",'."\n"
.' "rerunMode": "Allowed",'."\n"
.' "rerunTimes": 3,'."\n"
.' "rerunInterval": 180000,'."\n"
.' "failureStrategy": "Break"'."\n"
.' },'."\n"
.' "name": "OpenAPI_Test_Workflow_Demo",'."\n"
.' "outputs": {'."\n"
.' "nodeOutputs": ['."\n"
.' {'."\n"
.' "data": "workflow_output",'."\n"
.' "artifactType": "NodeOutput",'."\n"
.' "refTableName": "OpenAPI_Test_Workflow_Demo"'."\n"
.' }'."\n"
.' ]'."\n"
.' },'."\n"
.' "dependencies": []'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求的ID。用于定位日志，排查问题。', 'type' => 'string', 'example' => '20BF7E80-668A-5620-8AD8-879B8FEA****'],
'Success' => ['description' => '是否调用成功，取值如下：'."\n"
."\n"
.'- true：调用成功。 '."\n"
.'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20BF7E80-668A-5620-8AD8-879B8FEA****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新数据开发工作流信息',
'description' => '>该接口不支持批量操作，若FlowSpec中定义了不止一个工作流，则除第一个以外的后续工作流均会被忽略。此外，工作流内部定义的节点也会被直接忽略，请调用UpdateNode接口依次更新内部节点。>',
'changeSet' => [
['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'dataworks.cn-wulanchabu.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-beijing.aliyuncs.com', 'endpoint' => 'dataworks.cn-beijing.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-shanghai.aliyuncs.com', 'endpoint' => 'dataworks.cn-shanghai.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-hongkong.aliyuncs.com', 'endpoint' => 'dataworks.cn-hongkong.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'dataworks.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dataworks.cn-shenzhen.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'regionName' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.ap-northeast-2.aliyuncs.com', 'endpoint' => 'dataworks.ap-northeast-2.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-northeast-2.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.ap-northeast-1.aliyuncs.com', 'endpoint' => 'dataworks.ap-northeast-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-chengdu.aliyuncs.com', 'endpoint' => 'dataworks.cn-chengdu.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dataworks.ap-southeast-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.ap-southeast-3.aliyuncs.com', 'endpoint' => 'dataworks.ap-southeast-3.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.ap-southeast-5.aliyuncs.com', 'endpoint' => 'dataworks.ap-southeast-5.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dataworks.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dataworks.cn-hangzhou.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dataworks.us-east-1.aliyuncs.com', 'endpoint' => 'dataworks.us-east-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dataworks.eu-west-1.aliyuncs.com', 'endpoint' => 'dataworks.eu-west-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.eu-west-1.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dataworks.us-west-1.aliyuncs.com', 'endpoint' => 'dataworks.us-west-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dataworks.eu-central-1.aliyuncs.com', 'endpoint' => 'dataworks.eu-central-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'dataworks.me-east-1.aliyuncs.com', 'endpoint' => 'dataworks.me-east-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.me-east-1.aliyuncs.com'],
['regionId' => 'me-central-1', 'regionName' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'dataworks.me-central-1.aliyuncs.com', 'endpoint' => 'dataworks.me-central-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.me-central-1.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dataworks.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'dataworks.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dataworks.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'dataworks.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shanghai-finance-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dataworks.aliyuncs.com', 'endpoint' => 'dataworks.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'BusinessError.Dictionary.InvalidDictionaryOrNoPermission', 'message' => 'Data albums do not exist, or you do not have permissions.', 'http_code' => 500, 'description' => '数据专辑不存在或者您没有权限。'],
['code' => 'BusinessError.Dictionary.InvalidUserId', 'message' => 'Invalid user ID.', 'http_code' => 500, 'description' => '不合法的用户ID'],
['code' => 'BusinessError.Dictionary.MountDictionaryCountOverLimit', 'message' => 'The maximum number of directories that can be added is 8. No more directories can be added.', 'http_code' => 500, 'description' => '最大的目录挂载数量是8个，不能继续挂载。'],
['code' => 'BusinessError.Dictionary.NoPermissionToUpdateOtherDictionary', 'message' => 'You have insufficient permissions, only administrators can modify directory of other people.', 'http_code' => 500, 'description' => '您没有权限，必须是管理员才可以修改他人的目录。'],
['code' => 'BusinessError.Dictionry.InvalidDictionryOrNoPermission', 'message' => 'Albums that do not exist or do not have permission cannot be mounted.', 'http_code' => 500, 'description' => '数据专辑不存在或者您没有权限。'],
['code' => 'BusinessError.Dictionry.MountDictionryCountOverlimit', 'message' => 'The maximum mount limit is 8, and cannot continue to mount.', 'http_code' => 500, 'description' => '最大的目录挂载数量是8个，不能继续挂载。'],
['code' => 'ConnectionAlreadyExist', 'message' => 'The connection with envType %s and name %s already exists.', 'http_code' => 400, 'description' => '连接串名称重复'],
['code' => 'DataSource.CheckRamRoleFailure', 'message' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', 'http_code' => 400, 'description' => '校验数据源权限失败'],
['code' => 'DataSource.ConnectionStrProperty.PatternNotMatch', 'message' => 'The pattern value %s is invalid. The correct pattern is %s.', 'http_code' => 400, 'description' => '数据源连接串属性不匹配规则'],
['code' => 'DataSource.NotFound', 'message' => 'The specified data source ID %s does not exist.', 'http_code' => 400, 'description' => '数据源不存在'],
['code' => 'DESENSPLAN.DATATYPE.ERROR', 'message' => 'Sensitive type already has a desensitization rule.', 'http_code' => 400, 'description' => '敏感类型已经配置脱敏规则。'],
['code' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', 'message' => 'Sensitive type not exist.', 'http_code' => 400, 'description' => '敏感类型不存在。'],
['code' => 'DESENSPLAN.ID.ERROR', 'message' => 'Desensitization rule ID does not exist.', 'http_code' => 400, 'description' => '脱敏规则ID不存在。'],
['code' => 'DESENSPLAN.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => '页大小超限，最大为100。'],
['code' => 'DESENSPLAN.PARAM.ERROR', 'message' => 'Desensitization rule parameter error.', 'http_code' => 400, 'description' => '脱敏规则参数错误。'],
['code' => 'DESENSPLAN.SCENECODE.ERROR', 'message' => 'Scene code does not exist.', 'http_code' => 400, 'description' => '场景码不存在。'],
['code' => 'DESENSPLAN.SCENEID.ERROR', 'message' => 'Scene ID does not exist.', 'http_code' => 400, 'description' => '场景ID不存在。'],
['code' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', 'message' => 'The scene is not a secondary scene.', 'http_code' => 400, 'description' => '场景不是二级场景。'],
['code' => 'DESENSPLAN.SIZE.ERROR', 'message' => 'The number of desens plan exceeds the limit.', 'http_code' => 400, 'description' => '脱敏规则数量超限。'],
['code' => 'DESENSSCENE.ID.ERROR', 'message' => 'The desensitization scenario ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => '场景ID不存在或不属于该租户。'],
['code' => 'DESENSSCENE.IDLEVEL.ERROR', 'message' => 'The desensitization scenario is not a secondary scenario.', 'http_code' => 400, 'description' => '脱敏场景不是二级场景。'],
['code' => 'DESENSSCENE.PROJECT.ERROR', 'message' => 'The project space does not exist.', 'http_code' => 400, 'description' => '工作空间不存在。'],
['code' => 'DESENSSCENE.SIZE.ERROR', 'message' => 'The number of desens scene exceeds the limit.', 'http_code' => 400, 'description' => '脱敏场景数量超限。'],
['code' => 'DESENSSCENE.UESRGROUP.ERROR', 'message' => 'The user group ID does not match the tenant or does not exist.', 'http_code' => 400, 'description' => '用户组ID不存在或不属于该租户。'],
['code' => 'DESENSSTATUS.ID.ERROR', 'message' => 'The desens status switch ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => '脱敏开关id不存在或不属于该租户。'],
['code' => 'DESENSSTATUS.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => '页大小超限，最大为100。'],
['code' => 'DESENSSTATUS.SCENECODE.ERROR', 'message' => 'Scene code does not exist.', 'http_code' => 400, 'description' => '场景码不存在。'],
['code' => 'DESENSSTATUS.SIZE.ERROR', 'message' => 'The number of desens status exceeds the limit.', 'http_code' => 400, 'description' => '脱敏开关数量超限。'],
['code' => 'DESENSTEMPLATE.SCENE.ERROR', 'message' => 'Scene ID does not exist.', 'http_code' => 400, 'description' => '场景ID不存在。'],
['code' => 'DESENSTEMPLATE.SCENELEVEL.ERROR', 'message' => 'The scene is not a secondary scene.', 'http_code' => 400, 'description' => '场景不是二级场景。'],
['code' => 'ENGINE.NOT.ALLOW', 'message' => 'engine not allow.', 'http_code' => 400, 'description' => '引擎类型不允许。'],
['code' => 'Execute.FML.ProcessError', 'message' => 'Failed to execute FML statement.', 'http_code' => 500, 'description' => 'FML执行失败，请稍后再试！'],
['code' => 'Execute.FML.SystemError', 'message' => 'A system error occurred. FML statement execution failed.', 'http_code' => 500, 'description' => '系统异常，FML语句执行失败，请检查语句中参数是否正确。'],
['code' => 'Forbidden.Access', 'message' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'http_code' => 403, 'description' => '没有权限，请授权'],
['code' => 'Forbidden.DI.NoPrivilege', 'message' => 'No access.', 'http_code' => 403, 'description' => '没有权限访问'],
['code' => 'Forbidden.Meta.NoTenant', 'message' => 'The user is not the owner of any tenants.', 'http_code' => 403, 'description' => '当前的用户不是任何租户的所有者。'],
['code' => 'Forbidden.Wkbench.BaselineNoPermission', 'message' => 'You are not authorized to access the baseline.', 'http_code' => 400, 'description' => '无对应的基线权限。'],
['code' => 'Forbidden.Wkbench.NoProject', 'message' => 'You have not joined any project.', 'http_code' => 400, 'description' => '尚未加入任何工作空间。'],
['code' => 'Forbidden.Wkbench.ProjectNoPermission', 'message' => 'You are not authorized to access the workspace.', 'http_code' => 400, 'description' => '工作空间无权限。'],
['code' => 'Forbidden.Wkbench.RemindNoPermission', 'message' => 'You are not authorized to modify the reminder.', 'http_code' => 401, 'description' => '无权限修改该自定义提醒规则。'],
['code' => 'Forbidden.Wkbench.RemindOverlimit', 'message' => 'The maximum number of reminders is exceeded.', 'http_code' => 400, 'description' => '自定义提醒规则创建超限。'],
['code' => 'Forbidden.Wkbench.Unpurchase', 'message' => 'You have not purchased the service.', 'http_code' => 400, 'description' => '功能尚未购买。'],
['code' => 'Forbidden.Wkbench.UserNotExist', 'message' => 'The user does not exist.', 'http_code' => 401, 'description' => '用户不存在。'],
['code' => 'Guard.Fail.Acl.Auth', 'message' => 'Failed to run the authorization command.', 'http_code' => 400, 'description' => '执行授权命令失败，请确认MaxCompute项目是否正常。'],
['code' => 'Guard.Fail.Auth.Task', 'message' => 'Failed to run the authorization job.', 'http_code' => 400, 'description' => '执行授权任务失败，请确认MaxCompute项目是否正常。'],
['code' => 'Guard.Fail.External.Interface', 'message' => 'An error occurred while calling external API.', 'http_code' => 400, 'description' => '调用外部接口异常，请稍后重试。'],
['code' => 'Guard.Fail.MaxCompute.Commnd', 'message' => 'Failed to run the MaxCompute command.', 'http_code' => 400, 'description' => '执行MaxCompute命令失败。请确认目标MaxCompute项目是否正常。'],
['code' => 'Guard.Invalid.Account', 'message' => 'Failed to query the account information.', 'http_code' => 400, 'description' => '查询账号信息失败，请确认您传入的账号信息是否合法。'],
['code' => 'Guard.Invalid.ApproveAction', 'message' => 'The specified approval action is not supported.', 'http_code' => 400, 'description' => '你传入的审批动作不合法，请确认传入的审批动作。'],
['code' => 'Guard.Invalid.Approver', 'message' => 'No valid approval person is found.', 'http_code' => 400, 'description' => '无法找到合法的审批人。请确认您提交的申请单是否存在合法的审批人。'],
['code' => 'Guard.Invalid.AuthObject', 'message' => 'The authorization object does not exist.', 'http_code' => 400, 'description' => '授权的对象不存在。请确认要申请的对象是否正确。'],
['code' => 'Guard.Invalid.Date', 'message' => 'Failed to parse the date format.', 'http_code' => 400, 'description' => '传入的日期参数无法正确失败，请确认您传入的日期参数是否正确。'],
['code' => 'Guard.Invalid.Engine', 'message' => 'The engine type is not supported.', 'http_code' => 400, 'description' => '您传入的引擎类型参数暂不支持，请确认传入的引擎类型参数'],
['code' => 'Guard.Invalid.Flow', 'message' => 'The specified approval item number does not exist.', 'http_code' => 400, 'description' => '您传入的审批单号不存在，请确认您传入的审批单号。'],
['code' => 'Guard.Invalid.Flow.Finished', 'message' => 'The approval flow has ended.', 'http_code' => 400, 'description' => '目标申请单的审批流已结束，无法操作已经完成的审批流。'],
['code' => 'Guard.Invalid.Flow.Permission', 'message' => 'You are not authorized to manage the approval item.', 'http_code' => 400, 'description' => '您没有权限操作该审批单，请确认您调用接口的AK是否有权限操作目标审批单'],
['code' => 'Guard.Invalid.Grantee', 'message' => 'The account to be authorized is invalid.', 'http_code' => 400, 'description' => '授权的主体无效。请确认要授权的账号是否正确。'],
['code' => 'Guard.Invalid.MaxCompute.Action', 'message' => 'The permission type of MaxCompute is invalid.', 'http_code' => 400, 'description' => '你传入的MaxCompute权限类型不合法，请确认传入的MaxCompute权限类型。'],
['code' => 'Guard.Invalid.MaxCompute.Owner', 'message' => 'The owner of the MaxCompute project is not found.', 'http_code' => 400, 'description' => '未找到传入的MaxCompute项目的所有者，请确认该MaxCompute项目的所有者是否在项目中。'],
['code' => 'Guard.Invalid.MaxCompute.Project', 'message' => 'The MaxCompute project is not found.', 'http_code' => 400, 'description' => '未找到传入的MaxCompute项目，请确认传入的MaxCompute项目。'],
['code' => 'Guard.Invalid.Permission', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 400, 'description' => '您没有权限进行此操作，请确认您调用接口的AK是否有权限操作目标对象。'],
['code' => 'Guard.Not.Exists.Grantee', 'message' => 'The account to be authorized does not exist.', 'http_code' => 400, 'description' => '授权的主体不存在。请确认要授权的账号是否正确。'],
['code' => 'InternalError.DI.Parameter', 'message' => 'A DI internal error occurred.', 'http_code' => 500, 'description' => '数据集成内部业务错误'],
['code' => 'InternalError.Meta.NoCalcEngine', 'message' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'http_code' => 400, 'description' => '用户输入的 project 不正确'],
['code' => 'InternalError.Meta.TenantTimeOut', 'message' => 'Failed to connect to the interface network.', 'http_code' => 500, 'description' => '接口网络不通。'],
['code' => 'InternalError.Meta.Unknown', 'message' => 'An unknown error occurred while processing your request.', 'http_code' => 500, 'description' => '未知错误。'],
['code' => 'InternalError.System', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '内部报错'],
['code' => 'InternalError.Wkbench.ServiceError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '服务开小差了。'],
['code' => 'InternalError.Wkbench.SystemCallFail', 'message' => 'System call failed.', 'http_code' => 500, 'description' => '系统调用失败。'],
['code' => 'Invalid.CalcEngineEnvType', 'message' => 'The specified envType %s is invalid.', 'http_code' => 400, 'description' => '传入的引擎环境类型非法'],
['code' => 'Invalid.CalcEngineType', 'message' => 'The specified calcEngineType %s is invalid.', 'http_code' => 400, 'description' => '传入的引擎类型非法'],
['code' => 'Invalid.Connection.Empty', 'message' => 'You must specify the connection parameter.', 'http_code' => 400, 'description' => '数据源参数为空'],
['code' => 'Invalid.DataSource.DataSourceStatus', 'message' => 'The specified dataSourceStatus %s is invalid.', 'http_code' => 400, 'description' => '传入的数据源状态非法'],
['code' => 'Invalid.DataSource.DataSourceTypeNotExist', 'message' => 'The data source type %s does not exist.', 'http_code' => 400, 'description' => '数据源类型不存在。'],
['code' => 'Invalid.DataSource.DataSourceTypeNotSupport', 'message' => 'The dataSourceType %s and subType %s are not supported.', 'http_code' => 400, 'description' => '数据源类型暂不支持'],
['code' => 'Invalid.DI.Parameter', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => '参数错误'],
['code' => 'Invalid.DI.Parameter.File.Existed', 'message' => 'The file name already exists.', 'http_code' => 400, 'description' => '参数不合法，文件名已存在'],
['code' => 'Invalid.DQC.Parameter', 'message' => 'The specified parameters are invalid.', 'http_code' => 500, 'description' => '参数异常。'],
['code' => 'Invalid.Meta.AppNotExist', 'message' => 'The MaxCompute project does not exist.', 'http_code' => 400, 'description' => 'MaxCompute项目不存在。'],
['code' => 'Invalid.Meta.CategoryForbidden', 'message' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', 'http_code' => 403, 'description' => '类目删除失败，当前类目存在关联表，不能进行操作。'],
['code' => 'Invalid.Meta.CategoryIllegalDepth', 'message' => 'A category can contain a maximum of 4 levels.', 'http_code' => 400, 'description' => '类目层级超过4级。'],
['code' => 'Invalid.Meta.CategoryIllegalTenant', 'message' => 'The tenant ID is different in the parent and child categories.', 'http_code' => 403, 'description' => '父子类目的租户ID不一致。'],
['code' => 'Invalid.Meta.CategoryNameDuplicate', 'message' => 'The category name is duplicated at this level.', 'http_code' => 400, 'description' => '同一层级下，类目名称重复。'],
['code' => 'Invalid.Meta.CategoryRelationDuplicate"', 'message' => 'The table is already bound to the category.', 'http_code' => 400, 'description' => '类目已经关联该表。'],
['code' => 'Invalid.Meta.TableNotExist', 'message' => 'The table does not exist.', 'http_code' => 400, 'description' => '表不存在。'],
['code' => 'Invalid.Operation', 'message' => 'You cannot delete the bindingCalcEngine that is bound to the data source.', 'http_code' => 400, 'description' => '数据源绑定的计算引擎不允许删除'],
['code' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', 'message' => 'You must specify at least one of the compute engine ID and the connection string when the data source type is ODPS.', 'http_code' => 400, 'description' => 'odps类型数据源的计算引擎ID和连接串信息不能同时为空。'],
['code' => 'Invalid.Tenant.ConnectionNotExists', 'message' => 'The connection does not exist.', 'http_code' => 400, 'description' => '数据源不存在。'],
['code' => 'Invalid.Tenant.ProjectNotExists', 'message' => 'The project does not exist.', 'http_code' => 400, 'description' => '项目不存在。'],
['code' => 'Invalid.Tenant.UserAlreadyInProject', 'message' => 'The user already exists in the project.', 'http_code' => 400, 'description' => '待添加用户已经存在于工作空间中。'],
['code' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'message' => 'The user is not a project administrator or owner.', 'http_code' => 403, 'description' => '用户不是项目负责人或者项目管理员。'],
['code' => 'Invalid.Tenant.UserNotInProject', 'message' => 'The user is not in the project.', 'http_code' => 400, 'description' => '用户不在项目中。'],
['code' => 'Invalid.Tenant.UserNotInTenant', 'message' => 'The user is not in tenant.', 'http_code' => 403, 'description' => '用户不在租户中。'],
['code' => 'Invalid.Tenant.UserNotInTenant', 'message' => 'The user is not in the tenant.', 'http_code' => 400, 'description' => '待添加成员不在租户中。'],
['code' => 'Invalid.Wkbench.BaselineNotExist', 'message' => 'The baseline does not exist.', 'http_code' => 400, 'description' => '基线不存在。'],
['code' => 'Invalid.Wkbench.BaselineStatusNotExist', 'message' => 'The BaselineStatus does not exist.', 'http_code' => 400, 'description' => '基线实例不存在。'],
['code' => 'Invalid.Wkbench.InstanceNotExist', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => '任务实例不存在。'],
['code' => 'Invalid.Wkbench.NodeNotExist', 'message' => 'The node does not exist.', 'http_code' => 400, 'description' => '节点不存在。'],
['code' => 'Invalid.Wkbench.Parameter', 'message' => 'The specified parameters are invalid.', 'http_code' => 400, 'description' => '参数错误。'],
['code' => 'Invalid.Wkbench.RemindNotExist', 'message' => 'The reminder does not exist.', 'http_code' => 400, 'description' => '自定义提醒规则不存在。'],
['code' => 'Invalid.Wkbench.TopicNotExist', 'message' => 'The topic does not exist.', 'http_code' => 400, 'description' => '事件不存在。'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => '缺少必要的参数。'],
['code' => 'InvalidParameter.Meta.CommonError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '请求参数错误。'],
['code' => 'InvalidParameter.Meta.GuidFormat', 'message' => 'The GUID format is invalid.', 'http_code' => 400, 'description' => 'Guid格式错误。'],
['code' => 'InvalidParameter.Meta.Illegal', 'message' => 'The app guid parameter is invalid.', 'http_code' => 400, 'description' => 'App参数错误。'],
['code' => 'InvalidParameter.Meta.IllegalDate', 'message' => 'The date format is invalid.', 'http_code' => 400, 'description' => '日期格式错误。'],
['code' => 'InvalidParameter.Meta.IllegalPageError', 'message' => 'The parameter for paging is invalid.', 'http_code' => 400, 'description' => '分页信息错误。'],
['code' => 'InvalidParameter.Meta.NotExist', 'message' => 'The data does not exist.', 'http_code' => 400, 'description' => '数据不存在。'],
['code' => 'MissingParam.ConnectionStr.Property', 'message' => 'You must specify property %s required by the data source connection string.', 'http_code' => 400, 'description' => '数据源连接串信息必填属性缺失'],
['code' => 'Param.Invalid', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => '参数错误'],
['code' => 'Param.Invalid.File.Existed', 'message' => 'The file name already exists.', 'http_code' => 400, 'description' => '参数不合法，文件名已存在'],
['code' => 'PARAMS.ERROR', 'message' => 'param error.', 'http_code' => 400, 'description' => '参数错误。'],
['code' => 'PERMISSION.DENIED.ERROR', 'message' => 'Permission denied', 'http_code' => 403, 'description' => '权限不足。'],
['code' => 'Required.Parameter.Empty', 'message' => 'You must specify the parameter %s.', 'http_code' => 400, 'description' => '必填参数缺失'],
['code' => 'Throttling.Meta.CategoryRelationDuplicate', 'message' => 'The maximum number of categories is exceeded.', 'http_code' => 403, 'description' => '类目数量已经超过允许的最大数。'],
['code' => 'Throttling.Resource', 'message' => 'the number of API calls that you can make has reached the upper limit. You can upgrade the edition of your DataWorks service to obtain a larger quota for the number of API calls.', 'http_code' => 429, 'description' => '该资源已经达到您的使用上限，您可以升级DataWorks产品版本以获得更多的调用次数。'],
['code' => 'UNKNOWN.ERROR', 'message' => 'unknown error.', 'http_code' => 500, 'description' => '未知错误。'],
['code' => 'USERACCOUNT.OWNER.ERROR', 'message' => 'User list or owner user does not exist.', 'http_code' => 400, 'description' => '用户列表或负责人用户不存在。'],
['code' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', 'message' => 'The number of account exceeds the limit.', 'http_code' => 400, 'description' => '用户数量超限。'],
['code' => 'USERGROUP.ID.ERROR', 'message' => 'The user group ID does not match the tenant or does not exist.', 'http_code' => 400, 'description' => '用户组ID不存在或不属于该租户。'],
['code' => 'USERGROUP.LISTSIZE.ERROR', 'message' => 'The number of user groups exceeds the limit.', 'http_code' => 400, 'description' => '用户组数量超限。'],
['code' => 'USERGROUP.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => '页大小超限，最大为100。'],
['code' => 'Valid.FML.NoPermission', 'message' => 'You are not authorized to access the project resources.', 'http_code' => 400, 'description' => '您没有权限访问当前项目资源。'],
['code' => 'Valid.FML.OnlySupportQueryStatement', 'message' => 'Only FML query statement is supported.', 'http_code' => 400, 'description' => '只支持FML查询语句。'],
['code' => 'Valid.FML.ProductExpired', 'message' => '智能数据建模产品购买已到期', 'http_code' => 400, 'description' => '智能数据建模产品购买已到期'],
['code' => 'Valid.FML.ProductNotActivated', 'message' => '智能数据建模产品未开通', 'http_code' => 400, 'description' => '智能数据建模产品未开通'],
['code' => 'Valid.FML.ProjectNotExist', 'message' => 'The project does not exist.', 'http_code' => 400, 'description' => '项目信息不存在，请检查输入参数。'],
['code' => 'Valid.FML.StatementNotValid', 'message' => 'The FML statement is invalid.', 'http_code' => 400, 'description' => 'FML语句不合法，请参考FML语法文档：https://dataworks-doc.yuque.com/docs/share/ff7899ed-c433-4970-b20e-6582ea3939f3?# '],
['code' => 'WHITELIST.DESENSID.ERROR', 'message' => 'The desensitization rule ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => '场景ID不存在或不属于该租户。'],
['code' => 'WHITELIST.ENDTIME.ERROR', 'message' => 'end time cannot be earlier than start time.', 'http_code' => 400, 'description' => '结束时间不能早于开始时间。'],
['code' => 'WHITELIST.ID.ERROR', 'message' => 'The whitelist ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => '白名单ID不存在或不属于该租户。'],
['code' => 'WHITELIST.MCPROJECT.ERROR', 'message' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', 'http_code' => 400, 'description' => 'ProjectName在创建MaxCompute脱敏白名单时不能为空。'],
['code' => 'WHITELIST.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => '页大小超限，不能超过100。'],
['code' => 'WHITELIST.SIZE.ERROR', 'message' => 'The number of white list exceeds the limit.', 'http_code' => 400, 'description' => '白名单数量超限。'],
['code' => 'WHITELIST.STARTTIME.ERROR', 'message' => 'start time cannot be earlier than today.', 'http_code' => 400, 'description' => '开始时间不能早于今天。'],
['code' => 'WHITELIST.TIMEFORMAT.ERROR', 'message' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', 'http_code' => 400, 'description' => '时间参数格式化错误，需使用yyyy MM dd HH: mm: ss。'],
['code' => 'WHITELIST.USERGROUP.ERROR', 'message' => 'The user group ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => '用户组ID不存在或不属于该租户。'],
['code' => 'WHITELIST.USERGROUPEMPTY.ERROR', 'message' => 'User group ID cannot be empty.', 'http_code' => 400, 'description' => '用户组ID不能为空。'],
['code' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', 'message' => 'The number of user group exceeds the limit.', 'http_code' => 400, 'description' => '用户组数量超限。'],
],
'changeSet' => [
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListDataAssets'],
['description' => '请求参数发生变更', 'api' => 'ListDataAssetTags'],
],
'createdAt' => '2025-05-19T03:27:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateWorkflow'],
],
'createdAt' => '2025-05-15T07:09:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateResource'],
['description' => '请求参数发生变更', 'api' => 'UpdateResource'],
],
'createdAt' => '2025-05-06T02:38:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListNodes'],
],
'createdAt' => '2025-04-02T02:48:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityEvaluationTask'],
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityRule'],
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityRuleTemplate'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityEvaluationTask'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityRule'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityRuleTemplate'],
],
'createdAt' => '2025-03-31T05:58:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDIJob'],
['description' => '响应参数发生变更', 'api' => 'GetDIJob'],
],
'createdAt' => '2025-03-27T08:15:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityEvaluationTask'],
],
'createdAt' => '2025-03-27T06:36:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ExecuteAdhocWorkflowInstance'],
],
'createdAt' => '2025-03-20T11:25:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateWorkflowInstances'],
],
'createdAt' => '2025-02-27T09:42:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateRoute'],
['description' => '响应参数发生变更', 'api' => 'ListResourceGroups'],
],
'createdAt' => '2025-02-21T06:57:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetWorkflowDefinition'],
],
'createdAt' => '2025-02-18T02:45:30.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetDIJobLog'],
],
'createdAt' => '2025-02-17T09:06:10.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ExecuteAdhocWorkflowInstance'],
],
'createdAt' => '2025-02-11T02:31:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListResourceGroups'],
],
'createdAt' => '2025-02-10T12:42:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListRoutes'],
],
'createdAt' => '2025-01-23T11:24:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTask'],
['description' => '响应参数发生变更', 'api' => 'GetTaskInstance'],
['description' => '响应参数发生变更', 'api' => 'ListDownstreamTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListDownstreamTasks'],
['description' => '响应参数发生变更', 'api' => 'ListTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListTasks'],
['description' => '响应参数发生变更', 'api' => 'ListUpstreamTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListUpstreamTasks'],
],
'createdAt' => '2025-01-21T03:12:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateDataQualityEvaluationTask'],
],
'createdAt' => '2025-01-15T08:29:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityEvaluationTask'],
['description' => '响应参数发生变更', 'api' => 'GetDataQualityEvaluationTask'],
],
'createdAt' => '2025-01-15T08:15:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListTasks'],
],
'createdAt' => '2025-01-15T02:51:13.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListDownstreamTasks'],
['description' => '响应参数发生变更', 'api' => 'ListUpstreamTasks'],
],
'createdAt' => '2025-01-13T08:45:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateNode'],
['description' => '请求参数发生变更', 'api' => 'ListNodes'],
],
'createdAt' => '2025-01-13T07:48:44.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AbolishDeployment'],
['description' => '请求参数发生变更', 'api' => 'CreateDeployment'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateFunction'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateNode'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateResource'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateWorkflowDefinition'],
['description' => '请求参数发生变更', 'api' => 'DeleteFunction'],
['description' => '请求参数发生变更', 'api' => 'DeleteNode'],
['description' => '请求参数发生变更', 'api' => 'DeleteResource'],
['description' => '请求参数发生变更', 'api' => 'DeleteWorkflowDefinition'],
],
'createdAt' => '2025-01-13T07:36:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDIAlarmRule'],
['description' => '响应参数发生变更', 'api' => 'ListDIAlarmRules'],
['description' => '请求参数发生变更', 'api' => 'StartDIJob'],
['description' => '请求参数发生变更', 'api' => 'UpdateDIAlarmRule'],
],
'createdAt' => '2025-01-09T07:20:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateProject'],
],
'createdAt' => '2025-01-07T09:52:11.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTask'],
],
'createdAt' => '2025-01-07T07:52:53.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListDownstreamTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListDownstreamTasks'],
['description' => '响应参数发生变更', 'api' => 'ListTasks'],
['description' => '响应参数发生变更', 'api' => 'ListUpstreamTaskInstances'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListUpstreamTasks'],
['description' => '请求参数发生变更', 'api' => 'TriggerSchedulerTaskInstance'],
],
'createdAt' => '2025-01-06T09:33:24.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DeleteDIAlarmRule'],
['description' => '请求参数发生变更', 'api' => 'UpdateDIAlarmRule'],
],
'createdAt' => '2025-01-06T07:21:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateDIAlarmRule'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateDIJob'],
['description' => '请求参数发生变更', 'api' => 'DeleteDIAlarmRule'],
['description' => '请求参数发生变更', 'api' => 'DeleteDIJob'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetDIJob'],
['description' => '请求参数发生变更', 'api' => 'GetDIJobLog'],
['description' => '响应参数发生变更', 'api' => 'ListDIAlarmRules'],
['description' => '响应参数发生变更', 'api' => 'ListDIJobs'],
['description' => '请求参数发生变更', 'api' => 'StartDIJob'],
['description' => '请求参数发生变更', 'api' => 'StopDIJob'],
],
'createdAt' => '2025-01-06T05:34:53.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateResourceGroup'],
['description' => '响应参数发生变更', 'api' => 'GetResourceGroup'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListNetworks'],
],
'createdAt' => '2025-01-02T07:14:38.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateAlertRule'],
['description' => '响应参数发生变更', 'api' => 'GetAlertRule'],
['description' => '响应参数发生变更', 'api' => 'ListAlertRules'],
['description' => '请求参数发生变更', 'api' => 'UpdateAlertRule'],
],
'createdAt' => '2024-12-27T03:06:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AttachDataQualityRulesToEvaluationTask'],
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityEvaluationTask'],
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityRule'],
['description' => '请求参数发生变更', 'api' => 'CreateDataQualityRuleTemplate'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityEvaluationTask'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityRule'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityRuleTemplate'],
['description' => '请求参数发生变更', 'api' => 'DetachDataQualityRulesFromEvaluationTask'],
['description' => '请求参数发生变更', 'api' => 'GetDataQualityEvaluationTask'],
['description' => '请求参数发生变更', 'api' => 'GetDataQualityEvaluationTaskInstance'],
],
'createdAt' => '2024-12-23T06:29:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetDataQualityEvaluationTaskInstance'],
['description' => '响应参数发生变更', 'api' => 'GetDataQualityRule'],
['description' => '响应参数发生变更', 'api' => 'GetDataQualityRuleTemplate'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityEvaluationTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityEvaluationTasks'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityResults'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityRules'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityRuleTemplate'],
['description' => '请求参数发生变更', 'api' => 'UpdateDataQualityRule'],
],
'createdAt' => '2024-12-19T09:25:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CloneDataSource'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataSource'],
],
'createdAt' => '2024-12-19T09:00:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateNetwork'],
['description' => '响应参数发生变更', 'api' => 'CreateRoute'],
],
'createdAt' => '2024-12-19T08:50:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityRule'],
['description' => '请求参数发生变更', 'api' => 'DeleteDataQualityRuleTemplate'],
['description' => '请求参数发生变更', 'api' => 'GetDataQualityRule'],
['description' => '请求参数发生变更', 'api' => 'GetDataQualityRuleTemplate'],
],
'createdAt' => '2024-12-19T08:31:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UpdateDIJob'],
],
'createdAt' => '2024-12-11T02:02:52.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListDataQualityRules'],
],
'createdAt' => '2024-12-04T03:13:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListTaskInstances'],
],
'createdAt' => '2024-11-21T01:59:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetTask'],
['description' => '响应参数发生变更', 'api' => 'GetTaskInstance'],
['description' => '响应参数发生变更', 'api' => 'ListDownstreamTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListDownstreamTasks'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListTasks'],
['description' => '响应参数发生变更', 'api' => 'ListUpstreamTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListUpstreamTasks'],
],
'createdAt' => '2024-11-20T07:56:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListDataQualityEvaluationTaskInstances'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityEvaluationTasks'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityResults'],
['description' => '响应参数发生变更', 'api' => 'ListDataQualityRules'],
],
'createdAt' => '2024-11-06T02:57:04.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateProject'],
],
'createdAt' => '2024-10-17T08:04:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetDIJob'],
['description' => '请求参数发生变更', 'api' => 'ListDIJobEvents'],
['description' => '请求参数发生变更', 'api' => 'ListDIJobMetrics'],
['description' => '请求参数发生变更', 'api' => 'StartDIJob'],
['description' => '请求参数发生变更', 'api' => 'StopDIJob'],
],
'createdAt' => '2024-10-15T07:52:29.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetDIJob'],
],
'createdAt' => '2024-10-15T06:50:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DeleteDIJob'],
['description' => '请求参数发生变更', 'api' => 'GetDIJob'],
['description' => '请求参数发生变更', 'api' => 'UpdateDIJob'],
],
'createdAt' => '2024-10-14T09:34:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListNodes'],
],
'createdAt' => '2024-10-11T02:17:30.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
],
'ram' => [
'productCode' => 'DataWorks',
'productName' => '大数据开发治理平台 DataWorks',
'ramCodes' => ['dataworks'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'UpdateComponent',
'description' => '更新组件',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateComponent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateProject',
'description' => '更新工作空间',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTaskInstances',
'description' => '获取任务实例列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListTaskInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'TaskInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:taskinstance/*'],
],
],
],
[
'apiName' => 'DeleteDatasetVersion',
'description' => '删除数据集版本',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteDatasetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListNetworks',
'description' => '获取资源组网络资源列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListNetworks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDataSourceSharedRule',
'description' => '删除数据源分享规则',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:DeleteDataSourceSharedRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetNode',
'description' => '获取数据开发节点详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetNetwork',
'description' => '获取某个网络资源详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateResourceGroup',
'description' => '创建资源组',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'],
],
],
],
[
'apiName' => 'ListTasks',
'description' => '获取任务列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'Task', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:task/*'],
],
],
],
[
'apiName' => 'ListDataQualityTemplates',
'description' => '数据质量规则模板列表查询',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityAlertRule',
'description' => '获取数据质量告警规则',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityAlertRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateDatasetVersion',
'description' => '更新数据集版本信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateDatasetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateWorkflowDefinition',
'description' => '创建数据开发工作流',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DissociateProjectFromResourceGroup',
'description' => '将资源组和某个工作空间解除绑定',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:DissociateProjectFromResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTaskInstanceOperationLogs',
'description' => '获取任务实例的操作日志列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDatasets',
'description' => '查询数据集列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDatasets',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListResourceGroupAssociateProjects',
'description' => '获取资源组绑定工作空间列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListResourceGroupAssociateProjects',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
],
],
],
[
'apiName' => 'UpdateDataSource',
'description' => '修改数据源',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:UpdateDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartWorkflowInstances',
'description' => '启动工作流实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCrawlerTypes',
'description' => '获取数据地图元数据采集器类型列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListCrawlerTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFunction',
'description' => '获取数据开发函数详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDataset',
'description' => '创建数据集',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateDataset',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteWorkflowDefinition',
'description' => '删除数据开发工作流',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityScan',
'description' => '获取数据质量监控详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityScan',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'PreviewDatasetVersion',
'description' => '预览数据集版本内容',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:PreviewDatasetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateProject',
'description' => '新建工作空间',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'MoveResource',
'description' => '移动数据开发文件资源路径',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListImageVersions',
'description' => '获取指定镜像版本详情',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListImageVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwImage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwimage/{#id}'],
],
],
],
[
'apiName' => 'DeleteProject',
'description' => '移除工作空间',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityScanRun',
'description' => '获取数据质量扫描运行详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityScanRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateComputeResource',
'description' => '修改计算资源',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:UpdateComputeResource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDeploymentPackageFiles',
'description' => '获取待发布的文件版本列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPipelineRuns',
'description' => '获取发布流程列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteNetwork',
'description' => '解绑并删除通用资源组网络资源',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTask',
'description' => '获取任务的详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GrantMemberProjectRoles',
'description' => '授予工作空间成员新的空间角色',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:GrantMemberProjectRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAgentSession',
'description' => '创建新会话',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateAgentSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetWorkflowInstance',
'description' => '获取工作流实例的详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDatabases',
'description' => '查询数据地图数据库列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDatabases',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTaskInstanceLog',
'description' => '获取任务实例的运行日志',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataSource',
'description' => '查看数据源详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetProject',
'description' => '获取工作空间详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetProject',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateComputeResource',
'description' => '创建计算资源',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:CreateComputeResource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetResource',
'description' => '获取数据开发文件资源详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopTaskInstances',
'description' => '终止任务实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'MoveNode',
'description' => '移动数据开发节点路径',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataQualityScanRuns',
'description' => '数据质量扫描运行记录查询',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityScanRuns',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenameWorkflowDefinition',
'description' => '重命名数据开发工作流',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataQualityScans',
'description' => '数据质量校验任务列表查询',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityScans',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'LoadAgentSession',
'description' => '加载恢复Agent会话详情',
'operationType' => 'none',
'ramAction' => [
'action' => 'dataworks:LoadAgentSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateResource',
'description' => '创建数据开发文件资源',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetComputeResource',
'description' => '查看计算资源详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetComputeResource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ImportWorkflowDefinition',
'description' => '导入数据开发工作流',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetLineageRelationship',
'description' => '获取数据地图血缘关系',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetLineageRelationship',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenameFunction',
'description' => '重命名数据开发函数',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListResourceGroupMetricData',
'description' => '查询资源组指标数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListResourceGroupMetricData',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
],
],
],
[
'apiName' => 'GetProjectRole',
'description' => '获取工作空间角色详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetProjectRole',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RerunWorkflowInstances',
'description' => '重跑工作流实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:RerunWorkflowInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDataset',
'description' => '删除数据集',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteDataset',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTables',
'description' => '查询数据地图数据表列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListTables',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListWorkflowDefinitions',
'description' => '获取数据开发工作流列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPipelineRunItems',
'description' => '获取发布内容',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateResource',
'description' => '更新数据开发文件资源信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMetaEntity',
'description' => '获取元数据实体详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetMetaEntity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataQualityRules',
'description' => '查询质量规则列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListImages',
'description' => '获取镜像列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListImages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCreateWorkflowInstancesResult',
'description' => '获取创建工作流实例结果',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetCreateWorkflowInstancesResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityEvaluationTaskInstance',
'description' => '获取数据质量校验任务实例详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTaskInstance',
'description' => '获取任务实例的详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateDataset',
'description' => '更新数据集',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateDataset',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AbolishPipelineRun',
'description' => '终止发布流程',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListProjects',
'description' => '获取工作空间详情列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListProjects',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAgentSessionTokenUsage',
'description' => '查询会话Token用量',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetAgentSessionTokenUsage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListLineages',
'description' => '查询数据地图实体血缘列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListLineages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExecuteAdhocWorkflowInstance',
'description' => '执行临时工作流实例',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:ExecuteAdhocWorkflowInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTaskOperationLogs',
'description' => '获取任务的操作日志列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListTaskOperationLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataQualityAlertRules',
'description' => '数据质量告警规则列表查询',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDataQualityAlertRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetProjectMember',
'description' => '查询工作空间成员详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetProjectMember',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetJobStatus',
'description' => '获取异步API运行状态',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetJobStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCatalog',
'description' => '获取数据地图数据目录详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetCatalog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCertificate',
'description' => '查看认证文件',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetCertificate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityScanRunLog',
'description' => '获取数据质量扫描运行日志',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityScanRunLog',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CloneDataSource',
'description' => '克隆数据源',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:CloneDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDataSource',
'description' => '创建数据源',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:CreateDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListResourceGroups',
'description' => '获取资源组列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListResourceGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'],
],
],
],
[
'apiName' => 'CreateDataSourceSharedRule',
'description' => '创建数据源分享规则',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:CreateDataSourceSharedRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListAgentSessionArtifacts',
'description' => '查询会话Artifact列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListAgentSessionArtifacts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRoute',
'description' => '根据ID获取指定路由信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetRoute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListComputeResources',
'description' => '获取计算资源列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListComputeResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetComponent',
'description' => '获取组件详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetComponent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteResourceGroup',
'description' => '删除通用资源组',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateTaskInstances',
'description' => '修改任务实例属性',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDatabase',
'description' => '获取数据地图数据库详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDatabase',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelAgentSession',
'description' => '取消会话',
'operationType' => 'none',
'ramAction' => [
'action' => 'dataworks:CancelAgentSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteProjectMember',
'description' => '移除工作空间成员',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteProjectMember',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAgent',
'description' => '读取 Agent 详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExecPipelineRunStage',
'description' => '执行发布流程的指定阶段',
'operationType' => 'none',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCatalogs',
'description' => '查询数据地图数据目录列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListCatalogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetResourceGroup',
'description' => '根据ID获取指定资源组信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
],
],
],
[
'apiName' => 'GetCustomAttribute',
'description' => '获取自定义属性',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetCustomAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCustomAttribute',
'description' => '删除自定义属性',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteCustomAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListNodes',
'description' => '获取数据开发节点列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSchemas',
'description' => '查询数据地图数据库模式列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListSchemas',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListEntitiesInMetaCollection',
'description' => '查询数据地图集合中的实体列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListEntitiesInMetaCollection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityRule',
'description' => '查询质量规则详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetImage',
'description' => '根据ID获取指定镜像详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataQualityTemplate',
'description' => '获取数据质量规则模板',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataQualityTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListComponents',
'description' => '获取组件列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListComponents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteComputeResource',
'description' => '删除计算资源',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:DeleteComputeResource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RevokeMemberProjectRoles',
'description' => '撤销空间成员的空间角色',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:RevokeMemberProjectRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCustomAgents',
'description' => '分页列出 自定义 Agent',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListCustomAgents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddEntityIntoMetaCollection',
'description' => '向数据地图集合中添加实体对象',
'operationType' => 'none',
'ramAction' => [
'action' => 'dataworks:AddEntityIntoMetaCollection',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListProjectRoles',
'description' => '获取工作空间角色详情列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListProjectRoles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSkill',
'description' => '删除 Skill',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteSkill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDataSource',
'description' => '删除数据源',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:DeleteDataSource',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataQualityEvaluationTaskInstances',
'description' => '查询质量监控任务实例列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'TriggerSchedulerTaskInstance',
'description' => '触发调度任务实例',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListImageAssociatedProjects',
'description' => '查询镜像关联的工作空间列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListImageAssociatedProjects',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateCustomAttribute',
'description' => '更新自定义属性',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateCustomAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateResourceGroup',
'description' => '更新资源组基本信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
],
],
],
[
'apiName' => 'ListNodeDependencies',
'description' => '获取数据开发节点的依赖节点',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListColumns',
'description' => '查询数据地图数据表字段列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListColumns',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RerunTaskInstances',
'description' => '重跑任务实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateNetwork',
'description' => '创建资源组网络',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateNetwork',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetWorkflowDefinition',
'description' => '获取数据开发工作流详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPartitions',
'description' => '查询数据地图数据表的分区列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListPartitions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAgentSessionArtifactMeta',
'description' => '查询 Artifact 元信息与内容',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetAgentSessionArtifactMeta',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListMetaCollections',
'description' => '查询数据地图集合列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListMetaCollections',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDatasetVersion',
'description' => '创建数据集版本',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateDatasetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateFunction',
'description' => '创建数据开发函数',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AssociateProjectToResourceGroup',
'description' => '绑定资源组到某个工作空间',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:AssociateProjectToResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListWorkflowInstances',
'description' => '获取工作流实例列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDatasetVersion',
'description' => '获取数据集版本信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDatasetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPipelineRun',
'description' => '获取发布流程详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteRoute',
'description' => '删除网络资源的路由',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteRoute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetColumn',
'description' => '获取数据地图数据表字段信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetColumn',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateRoute',
'description' => '创建网络资源的路由',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateRoute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataSources',
'description' => '获取数据源列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListDataSources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCertificates',
'description' => '查询证书文件列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListCertificates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListFunctions',
'description' => '获取数据开发函数列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDownstreamTaskInstances',
'description' => '获取下游任务实例列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateRoute',
'description' => '更新路由信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:UpdateRoute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateTask',
'description' => '更新任务',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListProjectMembers',
'description' => '查询工作空间成员列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListProjectMembers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataQualityResults',
'description' => '查询质量结果列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListAgentSessions',
'description' => '查询会话列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListAgentSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCustomAttributes',
'description' => '查询自定义属性列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListCustomAttributes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCustomAttribute',
'description' => '创建自定义属性',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateCustomAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'PromptAgentSession',
'description' => '发送会话Prompt',
'operationType' => 'none',
'ramAction' => [
'action' => 'dataworks:PromptAgentSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteResource',
'description' => '删除数据开发文件资源',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDatasetVersions',
'description' => '获取数据集版本列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListDatasetVersions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateProjectMember',
'description' => '创建工作空间成员',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateProjectMember',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePipelineRun',
'description' => '创建发布流程',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListUpstreamTasks',
'description' => '获取上游任务列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenameNode',
'description' => '重命名数据开发节点',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopWorkflowInstances',
'description' => '终止工作流实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListLineageRelationships',
'description' => '查询数据地图血缘关系列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListLineageRelationships',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataQualityEvaluationTasks',
'description' => '查询质量监控任务列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateWorkflowInstances',
'description' => '创建工作流实例',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateWorkflowInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListUpstreamTaskInstances',
'description' => '获取上游任务实例列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDataSourceSharedRules',
'description' => '查询数据源分享规则列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:ListDataSourceSharedRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListRoutes',
'description' => '获取网络资源的路由列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListRoutes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCertificate',
'description' => '删除认证文件',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:DeleteCertificate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteComponent',
'description' => '删除组件',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dataworks:DeleteComponent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'TestDataSourceConnectivity',
'description' => '测试数据源的连通性',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:TestDataSourceConnectivity',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateIdentifyCredential',
'description' => '创建身份凭证',
'operationType' => 'create',
'ramAction' => [
'action' => 'dataworks:CreateIdentifyCredential',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListAgents',
'description' => '查询Agent列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:ListAgents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateWorkflowDefinition',
'description' => '更新数据开发工作流信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDataset',
'description' => '获取数据集详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetDataset',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListResources',
'description' => '获取数据开发文件资源列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'dataworks:*',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetTable',
'description' => '获取数据地图数据表详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'dataworks:GetTable',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'TaskInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:taskinstance/*'],
['validationType' => 'always', 'resourceType' => 'Network', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:network/*'],
['validationType' => 'always', 'resourceType' => 'Node', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:*'],
['validationType' => 'always', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'],
['validationType' => 'always', 'resourceType' => 'Task', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:task/*'],
['validationType' => 'always', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'],
['validationType' => 'always', 'resourceType' => 'ResourceFile', 'arn' => ':dataworks:{#regionId}::resourcefile/*'],
['validationType' => 'always', 'resourceType' => 'WorkflowInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workflowinstance/*'],
['validationType' => 'conditional', 'resourceType' => 'FileVersion', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:fileversion/*'],
['validationType' => 'conditional', 'resourceType' => 'Folder', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:folder/*'],
['validationType' => 'always', 'resourceType' => 'DwImage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwimage/{#id}'],
['validationType' => 'always', 'resourceType' => 'Workflow', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workflow/*'],
['validationType' => 'always', 'resourceType' => 'DwImage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwimage/*'],
['validationType' => 'conditional', 'resourceType' => 'File', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:file/*'],
['validationType' => 'always', 'resourceType' => 'Route', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:route/*'],
['validationType' => 'conditional', 'resourceType' => 'Business', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:business/*'],
['validationType' => 'conditional', 'resourceType' => 'UdfFile', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:udffile/*'],
['validationType' => 'conditional', 'resourceType' => 'Deployment', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:deployment/*'],
],
],
];