diff options
Diffstat (limited to 'data/zh_cn/emrstudio/2023-10-09')
| -rw-r--r-- | data/zh_cn/emrstudio/2023-10-09/api-docs.php | 2736 |
1 files changed, 2736 insertions, 0 deletions
diff --git a/data/zh_cn/emrstudio/2023-10-09/api-docs.php b/data/zh_cn/emrstudio/2023-10-09/api-docs.php new file mode 100644 index 0000000..3829cb1 --- /dev/null +++ b/data/zh_cn/emrstudio/2023-10-09/api-docs.php @@ -0,0 +1,2736 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'EmrStudio', + 'version' => '2023-10-09', + ], + 'directories' => [ + [ + 'id' => 190476, + 'title' => 'EMR Workflow手动任务实例管理', + 'type' => 'directory', + 'children' => [ + 'DescribeManualTaskInstance', + 'ListManualTaskInstances', + ], + ], + [ + 'id' => 190477, + 'title' => 'EMR Workflow手动任务管理', + 'type' => 'directory', + 'children' => [ + 'ListManualTasks', + 'DescribeManualTask', + ], + ], + [ + 'id' => 190469, + 'title' => 'EMR Workflow任务实例管理', + 'type' => 'directory', + 'children' => [ + 'ListTaskInstances', + 'DescribeTaskInstance', + ], + ], + [ + 'id' => 190470, + 'title' => 'EMR Workflow任务管理', + 'type' => 'directory', + 'children' => [ + 'ListTasks', + 'DescribeTask', + ], + ], + [ + 'id' => 190471, + 'title' => 'EMR Workflow工作流实例管理', + 'type' => 'directory', + 'children' => [ + 'ListWorkflowInstances', + 'DescribeWorkflowInstance', + ], + ], + [ + 'id' => 190472, + 'title' => 'EMR Workflow工作流管理', + 'type' => 'directory', + 'children' => [ + 'ListWorkflows', + 'DescribeWorkflow', + ], + ], + [ + 'id' => 190473, + 'title' => 'EMR Workflow项目管理', + 'type' => 'directory', + 'children' => [ + 'DescribeProject', + 'ListProjects', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeManualTaskInstance' => [ + 'summary' => '获取手动任务实例。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances/{manualTaskInstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '216078', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce3835LZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'manualTaskInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '手动任务实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'ManualTaskInstanceId' => [ + 'title' => '资源一级ID', + 'description' => '手动任务实例ID', + 'type' => 'string', + 'example' => '123abc***', + ], + 'ManualTaskInstanceName' => [ + 'title' => '资源名称', + 'description' => '手动任务实例名称', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'SubmitTime' => [ + 'title' => '提交时间', + 'description' => '提交时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ExternalAppId' => [ + 'title' => '外部应用ID', + 'description' => '外部应用ID', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID', + 'description' => '资源组ID', + 'type' => 'string', + 'example' => 'wg-123abc***', + ], + 'EmrClusterId' => [ + 'title' => 'EMR集群ID', + 'description' => 'EMR集群ID', + 'type' => 'string', + 'example' => 'c-b933c5aac7f7***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"ManualTaskInstanceId\\": \\"123abc***\\",\\n \\"ManualTaskInstanceName\\": \\"test\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SubmitTime\\": \\"2024-03-27 00:00:00\\",\\n \\"StartTime\\": \\"2024-03-27 00:00:00\\",\\n \\"EndTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ExternalAppId\\": \\"application_123_***\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"ResourceGroupId\\": \\"wg-123abc***\\",\\n \\"EmrClusterId\\": \\"c-b933c5aac7f7***\\"\\n}","type":"json"}]', + 'title' => '获取手动任务实例', + ], + 'ListManualTaskInstances' => [ + 'summary' => '获取手动任务实例列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '216082', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce3835LZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '标记当前开始读取的位置，置空表示从头开始', + 'type' => 'string', + 'required' => false, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'executionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '状态', + 'type' => 'string', + 'required' => false, + 'example' => 'SUCCESS', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2024-03-27 00:00:00', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2024-03-27 00:00:00', + ], + ], + ], + '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' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'nextToken' => [ + 'description' => '下一次请求的token。', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '记录总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ManualTaskInstanceId' => [ + 'title' => '资源一级ID', + 'description' => '手动任务实例ID', + 'type' => 'string', + 'example' => '123abc***', + ], + 'ManualTaskInstanceName' => [ + 'title' => '资源名称', + 'description' => '手动任务实例名称', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'SubmitTime' => [ + 'title' => '提交时间', + 'description' => '提交时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ExternalAppId' => [ + 'title' => '外部应用ID', + 'description' => '外部应用ID', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID', + 'description' => '资源组ID', + 'type' => 'string', + 'example' => 'wg-123abc***', + ], + 'EmrClusterId' => [ + 'title' => 'EMR集群ID', + 'description' => 'EMR集群ID', + 'type' => 'string', + 'example' => 'c-b933c5aac7f7***', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"ManualTaskInstanceId\\": \\"123abc***\\",\\n \\"ManualTaskInstanceName\\": \\"test\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SubmitTime\\": \\"2024-03-27 00:00:00\\",\\n \\"StartTime\\": \\"2024-03-27 00:00:00\\",\\n \\"EndTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ExternalAppId\\": \\"application_123_***\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"ResourceGroupId\\": \\"wg-123abc***\\",\\n \\"EmrClusterId\\": \\"c-b933c5aac7f7***\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取手动任务实例列表', + ], + 'ListManualTasks' => [ + 'summary' => '获取手动任务列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '215886', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceYP2JJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '标记当前开始读取的位置，置空表示从头开始', + 'type' => 'string', + 'required' => false, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型', + 'type' => 'string', + 'required' => false, + 'example' => 'SHELL', + ], + ], + ], + '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' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'nextToken' => [ + 'description' => '下一次请求的分页token。', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ManualTaskId' => [ + 'title' => '资源一级ID', + 'description' => '手动任务ID', + 'type' => 'string', + 'example' => '123***', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ManualTaskName' => [ + 'title' => '资源名称', + 'description' => '手动任务名称', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'title' => '项目ID', + 'description' => '项目ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'ResourceIds' => [ + 'title' => '资源id列表', + 'description' => '资源id列表', + 'type' => 'string', + 'example' => '123', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ParentDirectoryId' => [ + 'title' => '目录ID', + 'description' => '目录ID', + 'type' => 'string', + 'example' => '123***', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"ManualTaskId\\": \\"123***\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ManualTaskName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"123***\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"ResourceIds\\": \\"123\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ParentDirectoryId\\": \\"123***\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取手动任务列表', + ], + 'DescribeManualTask' => [ + 'summary' => '获取手动任务。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks/{manualTaskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '215786', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceYP2JJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'manualTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '手动任务ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'ManualTaskId' => [ + 'title' => '资源一级ID', + 'description' => '手动任务ID', + 'type' => 'string', + 'example' => '123***', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ManualTaskName' => [ + 'title' => '资源名称', + 'description' => '手动任务名称', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'title' => '项目ID', + 'description' => '项目ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'ResourceIds' => [ + 'title' => '资源id列表', + 'description' => '资源id列表', + 'type' => 'string', + 'example' => '123', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ParentDirectoryId' => [ + 'title' => '目录ID', + 'description' => '目录ID', + 'type' => 'string', + 'example' => '123***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"ManualTaskId\\": \\"123***\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ManualTaskName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"123***\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"ResourceIds\\": \\"123\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ParentDirectoryId\\": \\"123***\\"\\n}","type":"json"}]', + 'title' => '获取手动任务', + ], + 'ListTaskInstances' => [ + 'summary' => '获取任务实例列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/taskInstances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '216168', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce5Q1MGZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流实例ID', + 'type' => 'string', + 'required' => false, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'executionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '状态', + 'type' => 'string', + 'required' => false, + 'example' => 'SUCCESS', + ], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2024-03-27 00:00:00', + ], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2024-03-27 00:00:00', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '标记当前开始读取的位置，置空表示从头开始', + 'type' => 'string', + 'required' => false, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '25', + ], + ], + ], + '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' => '9E3A7161-EB7B-172B-8D18-FFB06BA38***', + ], + 'nextToken' => [ + 'description' => '分页Token', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '记录总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'data' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskInstanceId' => [ + 'title' => '任务实例ID', + 'description' => '任务实例ID', + 'type' => 'string', + 'example' => '123abc***', + ], + 'TaskInstanceName' => [ + 'title' => '任务实例名称', + 'description' => '任务实例名称', + 'type' => 'string', + 'example' => 'test', + ], + 'DryRun' => [ + 'title' => '空跑标识', + 'description' => '空跑标识', + 'type' => 'string', + 'example' => '0', + ], + 'EmrClusterId' => [ + 'title' => 'EMR集群ID', + 'description' => 'EMR集群ID', + 'type' => 'string', + 'example' => 'c-123abc***', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID', + 'description' => '资源组ID', + 'type' => 'string', + 'example' => 'wg-123abc***', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'ExternalAppId' => [ + 'title' => '外部应用ID', + 'description' => '外部应用ID', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'RetryTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'SubmitTime' => [ + 'title' => '提交时间', + 'description' => '提交时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'WorkflowInstanceId' => [ + 'title' => '工作流实例ID', + 'description' => '工作流实例ID', + 'type' => 'string', + 'example' => '123abc***', + ], + 'TaskVersion' => [ + 'title' => '任务版本', + 'description' => '任务版本', + 'type' => 'string', + 'example' => '1', + ], + 'TaskId' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9E3A7161-EB7B-172B-8D18-FFB06BA38***\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 100,\\n \\"data\\": [\\n {\\n \\"TaskInstanceId\\": \\"123abc***\\",\\n \\"TaskInstanceName\\": \\"test\\",\\n \\"DryRun\\": \\"0\\",\\n \\"EmrClusterId\\": \\"c-123abc***\\",\\n \\"ResourceGroupId\\": \\"wg-123abc***\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"ExternalAppId\\": \\"application_123_***\\",\\n \\"RetryTimes\\": 0,\\n \\"EndTime\\": \\"2024-03-27 00:00:00\\",\\n \\"StartTime\\": \\"2024-03-27 00:00:00\\",\\n \\"SubmitTime\\": \\"2024-03-27 00:00:00\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"WorkflowInstanceId\\": \\"123abc***\\",\\n \\"TaskVersion\\": \\"1\\",\\n \\"TaskId\\": \\"123***\\",\\n \\"TaskType\\": \\"SHELL\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取任务实例列表', + ], + 'DescribeTaskInstance' => [ + 'summary' => '获取任务实例。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowInstanceId}/taskInstances/{taskInstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '216159', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce5Q1MGZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '工作流实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'taskInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务实例ID', + 'type' => 'string', + 'required' => true, + 'example' => '123abc***', + ], + ], + ], + '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' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'TaskInstanceId' => [ + 'title' => '任务实例ID', + 'description' => '任务实例ID', + 'type' => 'string', + 'example' => '123abc***', + ], + 'TaskInstanceName' => [ + 'title' => '任务实例名称', + 'description' => '任务实例名称', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskId' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskVersion' => [ + 'title' => '任务版本', + 'description' => '任务版本', + 'type' => 'string', + 'example' => '1', + ], + 'WorkflowInstanceId' => [ + 'title' => '工作流实例ID', + 'description' => '工作流实例ID', + 'type' => 'string', + 'example' => '123abc***', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'SubmitTime' => [ + 'title' => '提交时间', + 'description' => '提交时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'RetryTimes' => [ + 'title' => '重试次数', + 'description' => '重试次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExternalAppId' => [ + 'title' => '外部应用ID', + 'description' => '外部应用ID', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID', + 'description' => '资源组ID', + 'type' => 'string', + 'example' => 'wg-123abc***', + ], + 'EmrClusterId' => [ + 'title' => 'EMR集群ID', + 'description' => 'EMR集群ID', + 'type' => 'string', + 'example' => 'c-b933c5aac7f7***', + ], + 'DryRun' => [ + 'title' => '空跑标识', + 'description' => '空跑标识', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"TaskInstanceId\\": \\"123abc***\\",\\n \\"TaskInstanceName\\": \\"test\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskId\\": \\"123***\\",\\n \\"TaskVersion\\": \\"1\\",\\n \\"WorkflowInstanceId\\": \\"123abc***\\",\\n \\"Status\\": \\"SUCCESS\\",\\n \\"SubmitTime\\": \\"2024-03-27 00:00:00\\",\\n \\"StartTime\\": \\"2024-03-27 00:00:00\\",\\n \\"EndTime\\": \\"2024-03-27 00:00:00\\",\\n \\"RetryTimes\\": 0,\\n \\"ExternalAppId\\": \\"application_123_***\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"ResourceGroupId\\": \\"wg-123abc***\\",\\n \\"EmrClusterId\\": \\"c-b933c5aac7f7***\\",\\n \\"DryRun\\": \\"0\\"\\n}","type":"json"}]', + 'title' => '获取任务实例', + ], + 'ListTasks' => [ + 'summary' => '获取任务列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/tasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '215894', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce61FDX5', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '标记当前开始读取的位置，置空表示从头开始', + 'type' => 'string', + 'required' => false, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型', + 'type' => 'string', + 'required' => false, + 'example' => 'SHELL', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流ID', + 'type' => 'string', + 'required' => false, + 'example' => '123***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'nextToken' => [ + 'description' => '下一次请求的分页token。', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '资源一级ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskName' => [ + 'title' => '资源名称', + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'Version' => [ + 'title' => '版本', + 'description' => '版本', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'title' => '项目ID', + 'description' => '项目ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'Flag' => [ + 'title' => '运行标志', + 'description' => '运行标志', + 'type' => 'string', + 'example' => 'YES', + ], + 'TaskPriority' => [ + 'title' => '任务优先级', + 'description' => '任务优先级', + 'type' => 'string', + 'example' => 'MEDIUM', + ], + 'FailRetryTimes' => [ + 'title' => '失败重试次数', + 'description' => '失败重试次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FailRetryInterval' => [ + 'title' => '失败重试间隔', + 'description' => '失败重试间隔', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TimeoutFlag' => [ + 'title' => '超时告警标志', + 'description' => '超时告警标志', + 'type' => 'string', + 'example' => 'CLOSE', + ], + 'TimeoutNotifyStrategy' => [ + 'title' => '超时策略', + 'description' => '超时策略', + 'type' => 'string', + 'example' => 'WARN', + ], + 'Timeout' => [ + 'title' => '超时时长', + 'description' => '超时时长', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DelayTime' => [ + 'title' => '延时执行时间', + 'description' => '延时执行时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceIds' => [ + 'title' => '资源ID列表', + 'description' => '资源ID列表', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"TaskId\\": \\"123***\\",\\n \\"TaskName\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"123***\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"Flag\\": \\"YES\\",\\n \\"TaskPriority\\": \\"MEDIUM\\",\\n \\"FailRetryTimes\\": 0,\\n \\"FailRetryInterval\\": 1,\\n \\"TimeoutFlag\\": \\"CLOSE\\",\\n \\"TimeoutNotifyStrategy\\": \\"WARN\\",\\n \\"Timeout\\": 0,\\n \\"DelayTime\\": 0,\\n \\"ResourceIds\\": \\"123\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取任务列表', + ], + 'DescribeTask' => [ + 'summary' => '获取任务。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}/tasks/{taskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '215898', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce61FDX5', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '工作流ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'TaskId' => [ + 'title' => '资源一级ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskName' => [ + 'title' => '资源名称', + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'Version' => [ + 'title' => '版本', + 'description' => '版本', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'title' => '项目ID', + 'description' => '项目ID', + 'type' => 'string', + 'example' => '123***', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + 'title' => '任务参数', + 'description' => '任务参数', + 'type' => 'string', + 'example' => '{'."\n" + .' "yarnUser": "",'."\n" + .' "conditionResult": "null",'."\n" + .' "rawScript": "sleep 300",'."\n" + .' "submitOnYarnFlag": false,'."\n" + .' "emrClusterId": "",'."\n" + .' "yarnPriority": "",'."\n" + .' "dependence": "null",'."\n" + .' "yarnMemory": "",'."\n" + .' "localParams": [],'."\n" + .' "switchResult": "null",'."\n" + .' "resourceList": [],'."\n" + .' "yarnQueue": "",'."\n" + .' "yarnVCores": "",'."\n" + .' "associateManualTaskFlag": false'."\n" + .'}', + ], + 'Flag' => [ + 'title' => '运行标志', + 'description' => '运行标志', + 'type' => 'string', + 'example' => 'YES', + ], + 'TaskPriority' => [ + 'title' => '任务优先级', + 'description' => '任务优先级', + 'type' => 'string', + 'example' => 'MEDIUM', + ], + 'FailRetryTimes' => [ + 'title' => '失败重试次数', + 'description' => '失败重试次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FailRetryInterval' => [ + 'title' => '失败重试间隔', + 'description' => '失败重试间隔', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TimeoutFlag' => [ + 'title' => '超时告警标志', + 'description' => '超时告警标志', + 'type' => 'string', + 'example' => 'CLOSE', + ], + 'TimeoutNotifyStrategy' => [ + 'title' => '超时策略', + 'description' => '超时策略', + 'type' => 'string', + 'example' => 'WARN', + ], + 'Timeout' => [ + 'title' => '超时时长', + 'description' => '超时时长', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DelayTime' => [ + 'title' => '延时执行时间', + 'description' => '延时执行时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceIds' => [ + 'title' => '资源ID列表', + 'description' => '资源ID列表', + 'type' => 'string', + 'example' => '123', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"TaskId\\": \\"123***\\",\\n \\"TaskName\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"123***\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"Flag\\": \\"YES\\",\\n \\"TaskPriority\\": \\"MEDIUM\\",\\n \\"FailRetryTimes\\": 0,\\n \\"FailRetryInterval\\": 1,\\n \\"TimeoutFlag\\": \\"CLOSE\\",\\n \\"TimeoutNotifyStrategy\\": \\"WARN\\",\\n \\"Timeout\\": 10,\\n \\"DelayTime\\": 0,\\n \\"ResourceIds\\": \\"123\\"\\n}","type":"json"}]', + 'title' => '获取任务', + ], + 'ListWorkflowInstances' => [ + 'summary' => '工作流实例列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/processInstances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216203', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceVHPGXM', + ], + ], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标', + 'type' => 'string', + 'required' => false, + 'example' => '8bj81uI8nls='."\n", + ], + ], + [ + 'name' => 'startDate', + 'in' => 'query', + 'schema' => [ + 'description' => '按工作流实例开始运行时间筛选', + 'type' => 'string', + 'required' => false, + 'example' => '2024-02-04 00:00:00', + ], + ], + [ + 'name' => 'endDate', + 'in' => 'query', + 'schema' => [ + 'description' => '按工作流实例结束运行时间筛选', + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-27 00:00:00', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '318546', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1231311', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => 'Id of the request', + 'description' => '分页游标，非空说明有更多数据', + 'type' => 'string', + 'example' => '8bj81uI8nls='."\n", + ], + 'totalSize' => [ + 'description' => '记录总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4292', + ], + 'data' => [ + 'description' => '工作流实例列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作流实例详情', + 'type' => 'object', + 'properties' => [ + 'workflowInstanceId' => [ + 'description' => '工作流实例ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'workflowId' => [ + 'description' => '工作流ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'workflowVersion' => [ + 'description' => '工作流版本号', + 'type' => 'string', + 'example' => '1234', + ], + 'state' => [ + 'description' => '工作流实例状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'SUCCESS' => 'SUCCESS', + 'RUNNING_EXECUTION' => 'RUNNING_EXECUTION', + 'FAILURE' => 'FAILURE', + ], + 'example' => 'RUNNING_EXECUTION', + ], + 'startDate' => [ + 'description' => '工作流实例开始运行时间', + 'type' => 'string', + 'example' => '2023-05-19 00:00:00', + ], + 'endDate' => [ + 'description' => '工作流实例结束运行时间', + 'type' => 'string', + 'example' => '2023-12-24 01:00:00', + ], + 'runTimes' => [ + 'description' => '工作流实例运行重试次数', + 'type' => 'string', + 'example' => '3', + ], + 'name' => [ + 'description' => '工作流实例名称', + 'type' => 'string', + 'example' => 'workflow_instance_name', + ], + 'scheduleTime' => [ + 'description' => '工作流实例调度时间', + 'type' => 'string', + 'example' => '2024-01-01 10:30:30', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '1DF8BA1E-F26F-50C9-9A27-8261ECB85259', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"8bj81uI8nls=\\\\n\\",\\n \\"totalSize\\": 4292,\\n \\"data\\": [\\n {\\n \\"workflowInstanceId\\": 123123,\\n \\"workflowId\\": 123,\\n \\"workflowVersion\\": \\"1234\\",\\n \\"state\\": \\"RUNNING_EXECUTION\\",\\n \\"startDate\\": \\"2023-05-19 00:00:00\\",\\n \\"endDate\\": \\"2023-12-24 01:00:00\\",\\n \\"runTimes\\": \\"3\\",\\n \\"name\\": \\"workflow_instance_name\\",\\n \\"scheduleTime\\": \\"2024-01-01 10:30:30\\"\\n }\\n ],\\n \\"requestId\\": \\"1DF8BA1E-F26F-50C9-9A27-8261ECB85259\\"\\n}","type":"json"}]', + 'title' => '获取工作流实例列表', + ], + 'DescribeWorkflowInstance' => [ + 'summary' => '工作流实例详情。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/processInstances/{workflowInstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216209', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceVHPGXM', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '工作流实例ID', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '工作流实例详情', + 'type' => 'object', + 'properties' => [ + 'workflowId' => [ + 'description' => '工作流ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1231311', + ], + 'workflowVersion' => [ + 'description' => '工作流版本号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'state' => [ + 'description' => '工作流实例状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'SUCCESS' => 'SUCCESS', + 'RUNNING_EXECUTION' => 'RUNNING_EXECUTION', + 'FAILURE' => 'FAILURE', + ], + 'example' => 'SUCCESS', + ], + 'startDate' => [ + 'description' => '工作流实例开始运行时间', + 'type' => 'string', + 'example' => '2024-02-04 00:00:00', + ], + 'endDate' => [ + 'description' => '工作流实例结束运行时间', + 'type' => 'string', + 'example' => '2023-06-02 10:30:00', + ], + 'runTimes' => [ + 'description' => '工作流实例运行次数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'name' => [ + 'description' => '工作流实例名称', + 'type' => 'string', + 'example' => 'workflow_instance_name', + ], + 'scheduleTime' => [ + 'description' => '工作流实例调度时间', + 'type' => 'string', + 'example' => '2024-01-01 10:59:00', + ], + 'emrClusterId' => [ + 'description' => '工作流实例运行资源组关联的EMR集群id', + 'type' => 'string', + 'example' => 'c-047fa6bbe732e12d', + ], + 'timeout' => [ + 'description' => '工作流实例超时时间', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'resourceGroupId' => [ + 'description' => '工作流实例运行资源组id', + 'type' => 'string', + 'example' => 'wg-acfmv4opbsduvfy', + ], + 'isComplementData' => [ + 'description' => '是否为补数实例', + 'type' => 'boolean', + 'example' => 'false', + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'B897B94B-6754-5D09-AB8C-2E8186CCADC0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"workflowId\\": 1231311,\\n \\"workflowVersion\\": 2,\\n \\"state\\": \\"SUCCESS\\",\\n \\"startDate\\": \\"2024-02-04 00:00:00\\",\\n \\"endDate\\": \\"2023-06-02 10:30:00\\",\\n \\"runTimes\\": 2,\\n \\"name\\": \\"workflow_instance_name\\",\\n \\"scheduleTime\\": \\"2024-01-01 10:59:00\\",\\n \\"emrClusterId\\": \\"c-047fa6bbe732e12d\\",\\n \\"timeout\\": 10,\\n \\"resourceGroupId\\": \\"wg-acfmv4opbsduvfy\\",\\n \\"isComplementData\\": false,\\n \\"requestId\\": \\"B897B94B-6754-5D09-AB8C-2E8186CCADC0\\"\\n}","type":"json"}]', + 'title' => '获取工作流实例详情', + ], + 'ListWorkflows' => [ + 'summary' => '工作流列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/processDefinitions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216191', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标。'."\n" + .'> 该字段不为空，表示有更多数据。', + 'type' => 'string', + 'required' => false, + 'example' => '8bj81uI8nls='."\n", + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '一次获取的最大记录数', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索值', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '309277', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => '工作流列表', + 'type' => 'array', + 'items' => [ + 'description' => '工作流信息', + 'type' => 'object', + 'properties' => [ + 'workflowId' => [ + 'description' => '工作流id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1231311', + ], + 'name' => [ + 'description' => '工作流名称', + 'type' => 'string', + 'example' => 'workflow_name', + ], + 'releaseState' => [ + 'description' => '工作流上线状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'ONLINE' => 'ONLINE', + 'OFFLINE' => 'OFFLINE', + ], + 'example' => 'ONLINE', + ], + 'description' => [ + 'description' => '工作流描述', + 'type' => 'string', + 'example' => 'workflow description', + ], + 'createTime' => [ + 'description' => '创建时间，时间戳。', + 'type' => 'string', + 'example' => '2023-06-07T02:35:13Z', + ], + 'updateTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2023-10-30T14:22:03Z', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => '分页Token，没有下一页则为空', + 'type' => 'string', + 'example' => '8bj81uI8nls='."\n", + ], + 'totalSize' => [ + 'description' => '记录总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"workflowId\\": 1231311,\\n \\"name\\": \\"workflow_name\\",\\n \\"releaseState\\": \\"ONLINE\\",\\n \\"description\\": \\"workflow description\\",\\n \\"createTime\\": \\"2023-06-07T02:35:13Z\\",\\n \\"updateTime\\": \\"2023-10-30T14:22:03Z\\"\\n }\\n ],\\n \\"nextToken\\": \\"8bj81uI8nls=\\\\n\\",\\n \\"totalSize\\": 10,\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + 'title' => '获取工作流列表', + ], + 'DescribeWorkflow' => [ + 'summary' => '工作流列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/processDefinitions/{workflowId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216198', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作空间id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '项目id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '工作流id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123131', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Workflow详情', + 'type' => 'object', + 'properties' => [ + 'tasks' => [ + 'description' => 'workflow任务列表', + 'type' => 'array', + 'items' => [ + 'description' => '任务对象', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => '任务id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'name' => [ + 'description' => '任务名称', + 'type' => 'string', + 'example' => 'task_name', + ], + 'version' => [ + 'description' => '任务版本', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'description' => [ + 'description' => '任务描述', + 'type' => 'string', + 'example' => 'task description', + ], + ], + ], + ], + 'taskRelations' => [ + 'description' => '任务关联关系列表', + 'type' => 'array', + 'items' => [ + 'description' => '任务关联关系对象', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '关联关系名称', + 'type' => 'string', + 'example' => 'relation_name', + ], + 'preTaskId' => [ + 'description' => '上游任务id，如果为0，则说明没有上游节点', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'preTaskVersion' => [ + 'description' => '上游任务版本', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'postTaskId' => [ + 'description' => '下游任务id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'postTaskVersion' => [ + 'description' => '下游任务版本', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '611AD6E6-BFE3-5897-AA12-569F79DBAF9B', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"tasks\\": [\\n {\\n \\"taskId\\": 123123,\\n \\"name\\": \\"task_name\\",\\n \\"version\\": 1,\\n \\"description\\": \\"task description\\"\\n }\\n ],\\n \\"taskRelations\\": [\\n {\\n \\"name\\": \\"relation_name\\",\\n \\"preTaskId\\": 123,\\n \\"preTaskVersion\\": 1,\\n \\"postTaskId\\": 1234,\\n \\"postTaskVersion\\": 2\\n }\\n ],\\n \\"requestId\\": \\"611AD6E6-BFE3-5897-AA12-569F79DBAF9B\\"\\n}","type":"json"}]', + 'title' => '获得工作流详情', + ], + 'DescribeProject' => [ + 'summary' => '获取Project详情。', + 'path' => '/dolphinscheduler/v3/projects/{code}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215934', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceBYNX2K', + ], + ], + 'parameters' => [ + [ + 'name' => 'code', + 'in' => 'path', + 'schema' => [ + 'title' => '项目code', + 'description' => '项目id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id', + 'description' => '工作空间id', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'title' => '项目code', + 'description' => '项目code', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + 'name' => [ + 'title' => '项目名称', + 'description' => '项目名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project_name', + ], + 'description' => [ + 'title' => '项目描述', + 'description' => '项目描述', + 'type' => 'string', + 'required' => true, + 'example' => 'this is a project description', + ], + 'requestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'req_id', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": 12345,\\n \\"name\\": \\"test_project_name\\",\\n \\"description\\": \\"this is a project description\\",\\n \\"requestId\\": \\"req_id\\"\\n}","type":"json"}]', + 'title' => '获取项目详情', + ], + 'ListProjects' => [ + 'summary' => '获取EMR Workflow工作空间下的项目列表。', + 'path' => '/dolphinscheduler/v3/projects', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215844', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceBYNX2K', + ], + ], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页游标。'."\n" + ."\n" + .'- 如果是首次查询，该参数不传。'."\n" + ."\n" + .'- 如果是非首次查询，该参数传上次调用时返回的nextToken。', + 'type' => 'string', + 'required' => false, + 'example' => '8bj81uI8nls=', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索值，用于项目名称和描述的正则匹配', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。'."\n" + ."\n" + .'> 分页时，返回参数里返回数量。后续页数的获取，保持和初始页一致，不传默认100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + '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' => [ + 'nextToken' => [ + 'title' => 'Id of the request', + 'description' => '下一页的游标，为空字符串则表示分页结束。', + 'type' => 'string', + 'example' => '8bj81uI8nls='."\n", + ], + 'data' => [ + 'description' => '项目列表', + 'type' => 'array', + 'items' => [ + 'description' => '项目数据', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '项目名称', + 'type' => 'string', + 'example' => 'project_name', + ], + 'description' => [ + 'description' => '项目描述', + 'type' => 'string', + 'example' => '项目描述', + ], + 'projectId' => [ + 'description' => '项目id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '720594', + ], + 'code' => [ + 'description' => '项目代码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '14079B51-C226-5391-BFAF-6E44AC492C1F', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"8bj81uI8nls=\\\\n\\",\\n \\"data\\": [\\n {\\n \\"name\\": \\"project_name\\",\\n \\"description\\": \\"项目描述\\",\\n \\"projectId\\": 720594,\\n \\"code\\": 12345\\n }\\n ],\\n \\"requestId\\": \\"14079B51-C226-5391-BFAF-6E44AC492C1F\\"\\n}","type":"json"}]', + 'title' => '获取项目列表', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'emrstudio.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'emrstudio.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'emrstudio.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'emrstudio.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'emrstudio.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'emrstudio.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'emrstudio.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'emrstudio.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'emrstudio.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'emrstudio.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'emrstudio.cn-hongkong.aliyuncs.com', + ], + ], +]; |