From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/en_us/emrstudio/2023-10-09/api-docs.php | 2713 +++++++++++++++ data/en_us/emrstudio/2024-04-30/api-docs.php | 4728 ++++++++++++++++++++++++++ 2 files changed, 7441 insertions(+) create mode 100644 data/en_us/emrstudio/2023-10-09/api-docs.php create mode 100644 data/en_us/emrstudio/2024-04-30/api-docs.php (limited to 'data/en_us/emrstudio') diff --git a/data/en_us/emrstudio/2023-10-09/api-docs.php b/data/en_us/emrstudio/2023-10-09/api-docs.php new file mode 100644 index 0000000..0eae9dc --- /dev/null +++ b/data/en_us/emrstudio/2023-10-09/api-docs.php @@ -0,0 +1,2713 @@ + '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'EmrStudio', + 'version' => '2023-10-09', + ], + 'directories' => [ + [ + 'id' => 190476, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeManualTaskInstance', + 'ListManualTaskInstances', + ], + ], + [ + 'id' => 190477, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListManualTasks', + 'DescribeManualTask', + ], + ], + [ + 'id' => 190469, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTaskInstances', + 'DescribeTaskInstance', + ], + ], + [ + 'id' => 190470, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTasks', + 'DescribeTask', + ], + ], + [ + 'id' => 190471, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListWorkflowInstances', + 'DescribeWorkflowInstance', + ], + ], + [ + 'id' => 190472, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListWorkflows', + 'DescribeWorkflow', + ], + ], + [ + 'id' => 190473, + 'title' => null, + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'manualTaskInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'manualTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'taskInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '318546', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + ], + 'workflowId' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workflowId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'c-047fa6bbe732e12d', + ], + 'timeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'resourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wg-acfmv4opbsduvfy', + ], + 'isComplementData' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'requestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '8bj81uI8nls='."\n", + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'requestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123131', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'tasks' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'preTaskVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'postTaskId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'postTaskVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'title' => '项目code', + 'description' => '', + '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' => '', + '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"}]', + ], + 'ListProjects' => [ + 'summary' => '获取项目详情', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '8bj81uI8nls=', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '318720', + ], + 'code' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '', + '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"}]', + ], + ], + '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', + ], + ], +]; diff --git a/data/en_us/emrstudio/2024-04-30/api-docs.php b/data/en_us/emrstudio/2024-04-30/api-docs.php new file mode 100644 index 0000000..a83dbd9 --- /dev/null +++ b/data/en_us/emrstudio/2024-04-30/api-docs.php @@ -0,0 +1,4728 @@ + '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'EmrStudio', + 'version' => '2024-04-30', + ], + 'directories' => [ + [ + 'id' => 192395, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeProject', + 'ListProjects', + ], + ], + [ + 'id' => 192393, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListWorkflowDirectories', + 'RunWorkflow', + 'ListWorkflows', + 'DescribeWorkflow', + 'UpdateWorkflow', + 'CreateWorkflow', + 'DeleteWorkflow', + ], + ], + [ + 'id' => 192403, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListWorkflowInstances', + 'DescribeWorkflowInstance', + 'OperateWorkflowInstance', + ], + ], + [ + 'id' => 192406, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeManualTask', + 'ListManualTasks', + ], + ], + [ + 'id' => 192409, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeManualTaskInstance', + 'ListManualTaskInstances', + ], + ], + [ + 'id' => 192412, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTasks', + 'DescribeTask', + ], + ], + [ + 'id' => 192415, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeTaskInstance', + 'ListTaskInstances', + ], + ], + [ + 'id' => 197906, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListResourceGroups', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'DescribeId', + 'GetInstanceLog', + 'ListAlertGroups', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeProject' => [ + 'summary' => '获取项目详情', + 'path' => '/dolphinscheduler/v3/projects/{projectId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218057', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceBYNX2K', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求id', + 'description' => '', + 'type' => 'string', + 'example' => 'B897B94B-6754-5D09-AB8C-2E8186CCADC0', + ], + 'projectId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'p-3q9jo749ne5****', + ], + 'name' => [ + 'title' => '项目名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test_project_name', + ], + 'description' => [ + 'title' => '项目描述', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'this is a project description', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B897B94B-6754-5D09-AB8C-2E8186CCADC0\\",\\n \\"projectId\\": \\"p-3q9jo749ne5****\\",\\n \\"name\\": \\"test_project_name\\",\\n \\"description\\": \\"this is a project description\\"\\n}","type":"json"}]', + ], + 'ListProjects' => [ + 'summary' => '获取项目详情', + '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' => '221489', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceBYNX2K', + ], + ], + 'parameters' => [ + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + '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' => '123abc***', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'project_name', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'projectId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'p-3q9jo749ne5****', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"123abc***\\",\\n \\"data\\": [\\n {\\n \\"name\\": \\"project_name\\",\\n \\"description\\": \\"test\\",\\n \\"projectId\\": \\"p-3q9jo749ne5****\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"totalSize\\": 10\\n}","type":"json"}]', + ], + 'ListWorkflowDirectories' => [ + 'summary' => '查询工作流目录列表', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/directories', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '236078', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceYP2JJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目 ID。'."\n", + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间 ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '请求的分页 token。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '一次获取的最大记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'parentDirectoryId', + 'in' => 'query', + 'schema' => [ + 'title' => '父目录ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wd-y98v7non5d****', + ], + ], + [ + 'name' => 'directoryId', + 'in' => 'query', + 'schema' => [ + 'title' => '目录ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wd-y98v7non5dx****', + ], + ], + ], + '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' => [ + 'title' => '下一次请求的分页 token。', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'totalCount' => [ + 'title' => '记录总数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'title' => '返回结果。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '目录名称。', + 'description' => '', + 'type' => 'string', + 'example' => '目录名称。', + ], + 'workflowId' => [ + 'title' => '工作流ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'w-lxyy60mpgpg****', + ], + 'parentDirectoryId' => [ + 'title' => '父目录ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'wd-y98v7non5dx****', + ], + 'directoryId' => [ + 'title' => '目录ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'wd-y98v7non5dx****', + ], + 'projectId' => [ + 'title' => '项目ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'p-v7n28j0m4ol****', + ], + ], + ], + ], + 'maxResults' => [ + 'title' => '一次获取的最大记录数。', + 'description' => '', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"totalCount\\": 10,\\n \\"data\\": [\\n {\\n \\"name\\": \\"目录名称。\\",\\n \\"workflowId\\": \\"w-lxyy60mpgpg****\\",\\n \\"parentDirectoryId\\": \\"wd-y98v7non5dx****\\",\\n \\"directoryId\\": \\"wd-y98v7non5dx****\\",\\n \\"projectId\\": \\"p-v7n28j0m4ol****\\"\\n }\\n ],\\n \\"maxResults\\": \\"10\\"\\n}","type":"json"}]', + ], + 'RunWorkflow' => [ + 'summary' => '运行工作流', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/run-workflow', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '219779', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-3q9jo749ne5****', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'wg-acfmv4opbs****', + ], + ], + [ + 'name' => 'execType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'COMPLEMENT_DATA' => '', + 'START_PROCESS' => '', + ], + 'example' => 'START_PROCESS', + ], + ], + [ + 'name' => 'failureStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CONTINUE' => '', + 'END' => '', + ], + 'example' => 'END', + ], + ], + [ + 'name' => 'alertStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALL' => '', + 'SUCCESS' => '', + 'NONE' => '', + 'FAILURE' => '', + ], + 'example' => 'NONE', + ], + ], + [ + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ag-n72kong0832****', + ], + ], + [ + 'name' => 'workflowInstancePriority', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LOWEST' => 'LOWEST', + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'HIGHEST' => 'HIGHEST', + ], + 'example' => 'MEDIUM', + ], + ], + [ + 'name' => 'startParams', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"key1":"value1"}', + ], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'complementDependentMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OFF_MODE' => '', + 'ALL_DEPENDENT' => '', + ], + 'example' => 'OFF_MODE', + ], + ], + [ + 'name' => 'runMode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RUN_MODE_SERIAL' => '', + 'RUN_MODE_PARALLEL' => '', + ], + 'example' => 'RUN_MODE_PARALLEL', + ], + ], + [ + 'name' => 'expectedParallelismNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'scheduleTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01 00:00:00,2024-01-02 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****', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'ListWorkflows' => [ + 'summary' => '获取工作流列表', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221672', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + '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', + ], + ], + ], + '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' => '', + 'type' => 'string', + 'example' => 'w-3q9jo749ne5****', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workflow_name', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workflow description', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'updateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'parentDirectoryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wd-3q9jo749ne5****', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123abc****', + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"workflowId\\": \\"w-3q9jo749ne5****\\",\\n \\"name\\": \\"workflow_name\\",\\n \\"description\\": \\"workflow description\\",\\n \\"createTime\\": \\"2024-01-01 00:00:00\\",\\n \\"updateTime\\": \\"2024-01-01 00:00:00\\",\\n \\"parentDirectoryId\\": \\"wd-3q9jo749ne5****\\"\\n }\\n ],\\n \\"nextToken\\": \\"123abc****\\",\\n \\"totalSize\\": 10,\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'DescribeWorkflow' => [ + 'summary' => '获取工作流详情', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{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' => '221441', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-n72kong0832****', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-n72kong0832****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '611AD6E6-BFE3-5897-AA12-569F79DBAF9B', + ], + 'workflow' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workflowId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'w-n72kong0832****', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'workflowParams' => [ + 'description' => '', + 'type' => 'string', + 'example' => ' [{"prop":"key1","value":"value1"}]', + ], + 'parentDirectoryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wd-n72kong0832****', + ], + 'timeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'executionType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'SERIAL_WAIT' => '', + 'PARALLEL' => '', + ], + 'example' => 'PARALLEL', + ], + 'createTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'updateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + ], + ], + 'tasks' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'taskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 't-n72kong0832****', + ], + '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' => [ + 'preTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 't-n72kong0832****', + ], + 'postTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 't-n72kong0832****', + ], + ], + ], + ], + 'schedule' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'scheduleState' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'OFFLINE' => '', + 'ONLINE' => '', + ], + 'example' => 'OFFLINE', + ], + 'scheduleStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'scheduleEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'cronExpr' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0 0 * * * ? *', + ], + 'timeZone' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'failureStrategy' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'CONTINUE' => '', + 'END' => '', + ], + 'example' => 'END', + ], + 'alertStrategy' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'ALL' => '', + 'SUCCESS' => '', + 'NONE' => '', + 'FAILURE' => '', + ], + 'example' => 'NONE', + ], + 'alertGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ag-n72kong0832****', + ], + 'workflowInstancePriority' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'LOWEST' => 'LOWEST', + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'HIGHEST' => 'HIGHEST', + ], + 'example' => 'MEDIUM', + ], + 'resourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wg-susqimrr649x****', + ], + 'emrClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C-15F7AB9B53F1****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"611AD6E6-BFE3-5897-AA12-569F79DBAF9B\\",\\n \\"workflow\\": {\\n \\"workflowId\\": \\"w-n72kong0832****\\",\\n \\"name\\": \\"test\\",\\n \\"description\\": \\"test\\",\\n \\"workflowParams\\": \\" [{\\\\\\"prop\\\\\\":\\\\\\"key1\\\\\\",\\\\\\"value\\\\\\":\\\\\\"value1\\\\\\"}]\\",\\n \\"parentDirectoryId\\": \\"wd-n72kong0832****\\",\\n \\"timeout\\": 0,\\n \\"executionType\\": \\"PARALLEL\\",\\n \\"createTime\\": \\"2024-01-01 00:00:00\\",\\n \\"updateTime\\": \\"2024-01-01 00:00:00\\"\\n },\\n \\"tasks\\": [\\n {\\n \\"taskId\\": \\"t-n72kong0832****\\",\\n \\"name\\": \\"task_name\\",\\n \\"version\\": 1,\\n \\"description\\": \\"task description\\"\\n }\\n ],\\n \\"taskRelations\\": [\\n {\\n \\"preTaskId\\": \\"t-n72kong0832****\\",\\n \\"postTaskId\\": \\"t-n72kong0832****\\"\\n }\\n ],\\n \\"schedule\\": {\\n \\"scheduleState\\": \\"OFFLINE\\",\\n \\"scheduleStartTime\\": \\"2024-01-01 00:00:00\\",\\n \\"scheduleEndTime\\": \\"2024-01-01 00:00:00\\",\\n \\"cronExpr\\": \\"0 0 * * * ? *\\",\\n \\"timeZone\\": \\"Asia/Shanghai\\",\\n \\"failureStrategy\\": \\"END\\",\\n \\"alertStrategy\\": \\"NONE\\",\\n \\"alertGroupId\\": \\"ag-n72kong0832****\\",\\n \\"workflowInstancePriority\\": \\"MEDIUM\\",\\n \\"resourceGroupId\\": \\"wg-susqimrr649x****\\",\\n \\"emrClusterId\\": \\"C-15F7AB9B53F1****\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateWorkflow' => [ + 'summary' => '更新工作流', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '221014', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-n72kong0832****', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'taskRelationJson', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', + ], + ], + [ + 'name' => 'taskDefinitionJson', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' [{"taskId":"t1","name":"t1","taskParams":{"rawScript":"echo 1"},"taskType":"SHELL"}]', + ], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'workflowParams', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[{"prop":"key1","value":"value1"}]', + ], + ], + [ + 'name' => 'parentDirectoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wd-n72kong0832****', + ], + ], + [ + 'name' => 'timeout', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'executionType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SERIAL_WAIT' => '', + 'PARALLEL' => '', + ], + 'example' => 'PARALLEL', + ], + ], + [ + 'name' => 'scheduleState', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OFFLINE' => '', + 'ONLINE' => '', + ], + 'example' => 'OFFLINE', + ], + ], + [ + 'name' => 'scheduleStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01 00:00:00', + ], + ], + [ + 'name' => 'scheduleEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01 00:00:00', + ], + ], + [ + 'name' => 'cronExpr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0 0 * * * ? *', + ], + ], + [ + 'name' => 'timeZone', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Asia/Shanghai', + ], + ], + [ + 'name' => 'failureStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CONTINUE' => '', + 'END' => '', + ], + 'example' => 'END', + ], + ], + [ + 'name' => 'alertStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALL' => '', + 'SUCCESS' => '', + 'NONE' => '', + 'FAILURE' => '', + ], + 'example' => 'NONE', + ], + ], + [ + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ag-n72kong0832****', + ], + ], + [ + 'name' => 'workflowInstancePriority', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LOWEST' => 'LOWEST', + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'HIGHEST' => 'HIGHEST', + ], + 'example' => 'MEDIUM', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wg-acfmv4opbs****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'taskRelationJsonValue' => [ + 'type' => 'string', + ], + 'taskDefinitionJsonValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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****', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'CreateWorkflow' => [ + 'summary' => '创建工作流', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '220061', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-n72kong0832****', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'taskRelationJson', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', + ], + ], + [ + 'name' => 'taskDefinitionJson', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => ' [{"taskId":"t1","name":"t1","taskParams":{"rawScript":"echo 1"},"taskType":"SHELL"}]', + ], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'workflowParams', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' [{"prop":"key1","value":"value1"}]', + ], + ], + [ + 'name' => 'parentDirectoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wd-v7n2gp3vv3j****', + ], + ], + [ + 'name' => 'timeout', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'executionType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SERIAL_WAIT' => '', + 'PARALLEL' => '', + ], + 'example' => 'PARALLEL', + ], + ], + [ + 'name' => 'scheduleState', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'OFFLINE' => '', + 'ONLINE' => '', + ], + 'example' => 'OFFLINE', + ], + ], + [ + 'name' => 'scheduleStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01 00:00:00', + ], + ], + [ + 'name' => 'scheduleEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01 00:00:00', + ], + ], + [ + 'name' => 'cronExpr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0 0 * * * ? *', + ], + ], + [ + 'name' => 'timeZone', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Asia/Shanghai', + ], + ], + [ + 'name' => 'failureStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CONTINUE' => '', + 'END' => '', + ], + 'example' => 'END', + ], + ], + [ + 'name' => 'alertStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALL' => '', + 'SUCCESS' => '', + 'NONE' => '', + 'FAILURE' => '', + ], + 'example' => 'NONE', + ], + ], + [ + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ag-v7n2gp3vv3j****', + ], + ], + [ + 'name' => 'workflowInstancePriority', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LOWEST' => 'LOWEST', + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'HIGHEST' => 'HIGHEST', + ], + 'example' => 'MEDIUM', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wg-acfmv4opbs****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'taskRelationJsonValue' => [ + 'type' => 'string', + ], + 'taskDefinitionJsonValue' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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***', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workflowId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'w-acfmv4opbs****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9E3A7161-EB7B-172B-8D18-FFB06BA38***\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"workflowId\\": \\"w-acfmv4opbs****\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteWorkflow' => [ + 'summary' => '删除工作流', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '219539', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-3q9jo749ne5****', + ], + ], + ], + '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****', + ], + 'success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'ListWorkflowInstances' => [ + 'summary' => '获取工作流实例列表', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflowInstances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221706', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceVHPGXM', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + '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' => '10', + ], + ], + [ + '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' => 'status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SUCCESS', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'w-3q9jo749ne5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'nextToken' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workflowInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wi-3q9jo749ne5****', + ], + 'workflowId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'w-3q9jo749ne5****', + ], + 'workflowVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workflow_instance_name', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'startTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'endTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'scheduleTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + ], + ], + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"workflowInstanceId\\": \\"wi-3q9jo749ne5****\\",\\n \\"workflowId\\": \\"w-3q9jo749ne5****\\",\\n \\"workflowVersion\\": 1,\\n \\"name\\": \\"workflow_instance_name\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"startTime\\": \\"2024-01-01 00:00:00\\",\\n \\"endTime\\": \\"2024-01-01 00:00:00\\",\\n \\"scheduleTime\\": \\"2024-01-01 00:00:00\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', + ], + 'DescribeWorkflowInstance' => [ + 'summary' => '获取工作流实例详情', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflowInstances/{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' => '221702', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceVHPGXM', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'wf-3q9jo749ne5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'workflowInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wi-3q9jo749ne5****', + ], + 'workflowId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'w-3q9jo749ne5****', + ], + 'workflowVersion' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'startTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'endTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'scheduleTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'runTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'workflow_instance_name', + ], + 'resourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wg-susqimrr649x****', + ], + 'emrClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c-047fa6bbe732****', + ], + 'timeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'isComplementData' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'requestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + ], + 'failureStrategy' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'CONTINUE' => '', + 'END' => '', + ], + 'example' => 'END', + ], + 'alertStrategy' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'ALL' => '', + 'SUCCESS' => '', + 'NONE' => '', + 'FAILURE' => '', + ], + 'example' => 'NONE', + ], + 'alertGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ag-n72kong0832****', + ], + 'workflowInstancePriority' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'LOWEST' => 'LOWEST', + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'HIGHEST' => 'HIGHEST', + ], + 'example' => 'MEDIUM', + ], + 'restartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"workflowInstanceId\\": \\"wi-3q9jo749ne5****\\",\\n \\"workflowId\\": \\"w-3q9jo749ne5****\\",\\n \\"workflowVersion\\": 1,\\n \\"status\\": \\"SUCCESS\\",\\n \\"startTime\\": \\"2024-03-27 00:00:00\\",\\n \\"endTime\\": \\"2024-03-27 00:00:00\\",\\n \\"scheduleTime\\": \\"2024-03-27 00:00:00\\",\\n \\"runTimes\\": 1,\\n \\"name\\": \\"workflow_instance_name\\",\\n \\"resourceGroupId\\": \\"wg-susqimrr649x****\\",\\n \\"emrClusterId\\": \\"c-047fa6bbe732****\\",\\n \\"timeout\\": 0,\\n \\"isComplementData\\": false,\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"failureStrategy\\": \\"END\\",\\n \\"alertStrategy\\": \\"NONE\\",\\n \\"alertGroupId\\": \\"ag-n72kong0832****\\",\\n \\"workflowInstancePriority\\": \\"MEDIUM\\",\\n \\"restartTime\\": \\"2024-03-27 00:00:00\\"\\n}","type":"json"}]', + ], + 'OperateWorkflowInstance' => [ + 'summary' => '操作工作流实例', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/execute', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '235673', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce265SSG', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'workflowInstanceId' => [ + 'title' => '工作流实例ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wi-l9o479p8rrx****', + ], + 'execType' => [ + 'title' => '执行类型。'."\n" + .'取值范围：'."\n" + .'- REPEAT_RUNNING：重复运行工作流。'."\n" + .'- RECOVER_SUSPENDED_PROCESS： 恢复暂停工作流。'."\n" + .'- START_FAILURE_TASK_PROCESS：从失败任务开始运行工作流。'."\n" + .'- STOP：停止工作流。'."\n" + .'- PAUSE： 暂停工作流。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'PAUSE', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间 ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'w-lxyy60mpgpg****', + ], + ], + ], + '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****', + ], + 'success' => [ + 'title' => '是否成功。', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + ], + 'DescribeManualTask' => [ + 'summary' => '获取手动任务定义', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks/{manualTaskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221510', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceYP2JJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'manualTaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'mt-3q9jo749ne5****', + ], + ], + ], + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mt-3q9jo749ne5****', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ManualTaskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'p-3q9jo749ne5****', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'r-oy98v7n43el****', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ParentDirectoryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mtd-oy98v7n43el****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"ManualTaskId\\": \\"mt-3q9jo749ne5****\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ManualTaskName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"p-3q9jo749ne5****\\",\\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\\": \\"r-oy98v7n43el****\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ParentDirectoryId\\": \\"mtd-oy98v7n43el****\\"\\n}","type":"json"}]', + ], + 'ListManualTasks' => [ + 'summary' => '查询手动任务定义列表', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '221515', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceYP2JJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '10', + ], + ], + [ + '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' => '', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ManualTaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mt-3q9jo749ne5****', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ManualTaskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'p-3q9jo749ne5****', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'r-oy98v7n43el****', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ParentDirectoryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mtd-oy98v7n43el****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"ManualTaskId\\": \\"mt-3q9jo749ne5****\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ManualTaskName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"p-3q9jo749ne5****\\",\\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\\": \\"r-oy98v7n43el****\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ParentDirectoryId\\": \\"mtd-oy98v7n43el****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeManualTaskInstance' => [ + 'summary' => '获取手动任务实例', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances/{manualTaskInstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221526', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce3835LZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'manualTaskInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'mti-0k5vype05xm****', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + ], + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mti-0k5vype05xm****', + ], + 'ManualTaskInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'SubmitTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ExternalAppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wg-123abc***', + ], + 'EmrClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c-b933c5aac7f7***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"ManualTaskInstanceId\\": \\"mti-0k5vype05xm****\\",\\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"}]', + ], + 'ListManualTaskInstances' => [ + 'summary' => '获取手动任务实例列表', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '221584', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce3835LZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '10', + ], + ], + [ + 'name' => 'status', + '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' => '', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ManualTaskInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'mti-3q9jo749ne5****', + ], + 'ManualTaskInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'SubmitTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'ExternalAppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wg-3q9jo749ne5****', + ], + 'EmrClusterId' => [ + 'description' => '', + '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\\": \\"mti-3q9jo749ne5****\\",\\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-3q9jo749ne5****\\",\\n \\"EmrClusterId\\": \\"c-b933c5aac7f7***\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListTasks' => [ + 'summary' => '查询任务定义列表', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/tasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '221598', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce61FDX5', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123abc***', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'w-n72kong0832****', + ], + ], + ], + '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' => '', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 't-3q9jo749ne5****', + ], + 'TaskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'p-3q9jo749ne5****', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'YES', + ], + 'TaskPriority' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'LOWEST' => 'LOWEST', + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'HIGHEST' => 'HIGHEST', + ], + 'example' => 'MEDIUM', + ], + 'FailRetryTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FailRetryInterval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TimeoutFlag' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'CLOSE' => '', + 'OPEN' => '', + ], + 'example' => 'CLOSE', + ], + 'TimeoutNotifyStrategy' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'FAILED' => '', + 'WARNFAILED' => '', + 'WARN' => '', + ], + 'example' => 'WARN', + ], + 'Timeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DelayTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceIds' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'r-3q9jo749ne5****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"TaskId\\": \\"t-3q9jo749ne5****\\",\\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\\": \\"p-3q9jo749ne5****\\",\\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\\": \\"r-3q9jo749ne5****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeTask' => [ + 'summary' => '查询任务定义', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}/tasks/{taskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221586', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce61FDX5', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-3q9jo749ne5****', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 't-3q9jo749ne5****', + ], + ], + ], + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 't-3q9jo749ne5****', + ], + 'TaskName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'Version' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'ProjectId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'p-3q9jo749ne5****', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'NO' => 'NO', + 'YES' => 'YES', + ], + 'example' => 'YES', + ], + 'TaskPriority' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'LOWEST' => 'LOWEST', + 'HIGH' => 'HIGH', + 'MEDIUM' => 'MEDIUM', + 'LOW' => 'LOW', + 'HIGHEST' => 'HIGHEST', + ], + 'example' => 'MEDIUM', + ], + 'FailRetryTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FailRetryInterval' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TimeoutFlag' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'CLOSE' => 'CLOSE', + 'OPEN' => 'OPEN', + ], + 'example' => 'CLOSE', + ], + 'TimeoutNotifyStrategy' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'FAILED' => '', + 'WARNFAILED' => '', + 'WARN' => '', + ], + 'example' => 'WARN', + ], + 'Timeout' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'DelayTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ResourceIds' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'r-oy98v7n43el****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"TaskId\\": \\"t-3q9jo749ne5****\\",\\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\\": \\"p-3q9jo749ne5****\\",\\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\\": \\"r-oy98v7n43el****\\"\\n}","type":"json"}]', + ], + 'DescribeTaskInstance' => [ + 'summary' => '获取任务实例', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowInstanceId}/taskInstances/{taskInstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221606', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce5Q1MGZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'wi-3q9jo749ne5****', + ], + ], + [ + 'name' => 'taskInstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ti-3q9jo749ne5****', + ], + ], + ], + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ti-3q9jo749ne5****', + ], + 'TaskInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 't-3q9jo749ne5****', + ], + 'TaskVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'WorkflowInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wi-3q9jo749ne5****', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'SubmitTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'RetryTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ExternalAppId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wg-123abc***', + ], + 'EmrClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c-b933c5aac7f7***', + ], + 'DryRun' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"TaskInstanceId\\": \\"ti-3q9jo749ne5****\\",\\n \\"TaskInstanceName\\": \\"test\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskId\\": \\"t-3q9jo749ne5****\\",\\n \\"TaskVersion\\": \\"1\\",\\n \\"WorkflowInstanceId\\": \\"wi-3q9jo749ne5****\\",\\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"}]', + ], + 'ListTaskInstances' => [ + 'summary' => '获取任务实例列表', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/taskInstances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '221613', + 'abilityTreeNodes' => [ + 'FEATUREemapreduce5Q1MGZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123***', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-3q9jo749ne5****', + ], + ], + [ + 'name' => 'workflowInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'wi-3q9jo749ne5****', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'status', + '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' => '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' => '9E3A7161-EB7B-172B-8D18-FFB06BA38***', + ], + 'nextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123abc***', + ], + 'totalSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ti-3q9jo749ne5****', + ], + 'TaskInstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test', + ], + 'DryRun' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'EmrClusterId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'c-b933c5aac7f7***', + ], + 'ResourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wg-3q9jo749ne5****', + ], + 'TaskParams' => [ + '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' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'application_123_***', + ], + 'RetryTimes' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'SubmitTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2024-03-27 00:00:00', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'WorkflowInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'wi-3q9jo749ne5****', + ], + 'TaskVersion' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 't-3q9jo749ne5****', + ], + 'TaskType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHELL', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9E3A7161-EB7B-172B-8D18-FFB06BA38***\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"TaskInstanceId\\": \\"ti-3q9jo749ne5****\\",\\n \\"TaskInstanceName\\": \\"test\\",\\n \\"DryRun\\": \\"0\\",\\n \\"EmrClusterId\\": \\"c-b933c5aac7f7***\\",\\n \\"ResourceGroupId\\": \\"wg-3q9jo749ne5****\\",\\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\\": \\"wi-3q9jo749ne5****\\",\\n \\"TaskVersion\\": \\"1\\",\\n \\"TaskId\\": \\"t-3q9jo749ne5****\\",\\n \\"TaskType\\": \\"SHELL\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListResourceGroups' => [ + 'summary' => '查询调度资源组列表', + 'path' => '/dolphinscheduler/v3/resourcegroups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236258', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceYP2JJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间 ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-lxyy60mpgpg****', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '标记当前开始读取的位置。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '一次获取的最大记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'resourceGroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '调度资源组名称。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'resourceGroupType', + 'in' => 'query', + 'schema' => [ + 'title' => '调度资源组规格。'."\n" + .'取值范围：'."\n" + .'- CLUSTER_RESOURCE_GROUP：集群资源组。'."\n" + .'- CLUSTER_TEMPLATE_RESOURCE_GROUP：集群模版资源组。'."\n" + .'- DEFAULT_RESOURCE_GROUP：默认资源组。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CLUSTER_RESOURCE_GROUP', + ], + ], + ], + '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' => '', + 'type' => 'string', + 'example' => '1。', + ], + 'totalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'resourceGroupId' => [ + 'title' => '调度资源组ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'rg-acfm4ewqrznxxxx', + ], + 'createTime' => [ + 'title' => '创建时间。', + 'description' => '', + 'type' => 'string', + 'example' => '2024-09-26T02:10:04Z', + ], + 'resourceGroupName' => [ + 'title' => '调度资源组名称。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'paymentType' => [ + 'title' => '付费类型。', + 'description' => '', + 'type' => 'string', + 'example' => 'postpaid', + ], + 'resourceGroupType' => [ + 'title' => '调度资源组类型。', + 'description' => '', + 'type' => 'string', + 'example' => 'CLUSTER_RESOURCE_GROUP。', + ], + 'nodeType' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'EMR_W1_SMALL。', + ], + 'nodeMinCount' => [ + 'title' => '最小节点数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1。', + ], + 'nodeMaxCount' => [ + 'title' => '最大节点数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2。', + ], + 'associatedWorkspaces' => [ + 'title' => '关联工作空间列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workspaceId' => [ + 'title' => '工作空间ID。', + 'description' => '', + 'type' => 'string', + 'example' => '1200827。', + ], + 'workspaceName' => [ + 'title' => '工作空间名称。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'associatedClusterTemplates' => [ + 'title' => '关联集群模版列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'templateId' => [ + 'title' => '集群模版ID。', + 'description' => '', + 'type' => 'string', + 'example' => '78723f0dc36。', + ], + 'templateName' => [ + 'title' => '集群模版名称。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'clusterType' => [ + 'title' => '类型。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'associatedClusters' => [ + 'title' => '关联集群列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'clusterId' => [ + 'title' => '集群ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'c-3cd8ba94b36cxxxx', + ], + 'clusterName' => [ + 'title' => '集群名称。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'clusterType' => [ + 'title' => '类型。', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + 'maxResults' => [ + 'title' => '最大数量。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10。', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1。\\",\\n \\"totalCount\\": 16,\\n \\"data\\": [\\n {\\n \\"resourceGroupId\\": \\"rg-acfm4ewqrznxxxx\\",\\n \\"createTime\\": \\"2024-09-26T02:10:04Z\\",\\n \\"resourceGroupName\\": \\"离线资源组。\\",\\n \\"paymentType\\": \\"postpaid\\",\\n \\"resourceGroupType\\": \\"CLUSTER_RESOURCE_GROUP。\\",\\n \\"nodeType\\": \\"EMR_W1_SMALL。\\",\\n \\"nodeMinCount\\": 0,\\n \\"nodeMaxCount\\": 0,\\n \\"associatedWorkspaces\\": [\\n {\\n \\"workspaceId\\": \\"1200827。\\",\\n \\"workspaceName\\": \\"数据开发1组。\\"\\n }\\n ],\\n \\"associatedClusterTemplates\\": [\\n {\\n \\"templateId\\": \\"78723f0dc36。\\",\\n \\"templateName\\": \\"模版1。\\",\\n \\"clusterType\\": \\"集群类型，取值：\\\\n- **DATALAKE**。\\\\n- **CUSTOM**。\\\\n- **HADOOP**。\\"\\n }\\n ],\\n \\"associatedClusters\\": [\\n {\\n \\"clusterId\\": \\"c-3cd8ba94b36cxxxx\\",\\n \\"clusterName\\": \\"离线集群。\\",\\n \\"clusterType\\": \\"集群类型，取值：\\\\n- **DATALAKE**。\\\\n- **CUSTOM**。\\\\n- **HADOOP**。\\"\\n }\\n ]\\n }\\n ],\\n \\"maxResults\\": 0\\n}","type":"json"}]', + ], + 'DescribeId' => [ + 'summary' => '获取id关联信息', + 'path' => '/dolphinscheduler/v3/relatedIds', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236258', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceBYNX2K', + 'FEATUREemapreduce265SSG', + 'FEATUREemapreduceVHPGXM', + 'FEATUREemapreduce61FDX5', + 'FEATUREemapreduce5Q1MGZ', + 'FEATUREemapreduceYP2JJQ', + 'FEATUREemapreduce3835LZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'id', + 'in' => 'query', + 'schema' => [ + 'title' => 'id', + 'description' => 'id', + 'type' => 'string', + 'required' => true, + 'example' => 'p-123****', + ], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '111234', + ], + ], + ], + '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' => '1234567890', + ], + 'data' => [ + 'title' => '返回值', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'inputId' => [ + 'title' => '输入id', + 'description' => '', + 'type' => 'string', + 'example' => 'p-123****', + ], + 'inputIdType' => [ + 'title' => '输入id类型', + 'description' => '', + 'type' => 'string', + 'example' => 'PROJECT', + ], + 'workspaceId' => [ + 'title' => '工作空间id', + 'description' => '', + 'type' => 'string', + 'example' => 'workspace-123****', + ], + 'projectId' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'example' => 'p-123****', + ], + 'workflowId' => [ + 'title' => '工作流id', + 'description' => '', + 'type' => 'string', + 'example' => 'w-123****', + ], + 'workflowInstanceId' => [ + 'title' => '工作流实例id', + 'description' => '', + 'type' => 'string', + 'example' => 'wi-123****', + ], + 'taskId' => [ + 'title' => '任务id', + 'description' => '', + 'type' => 'string', + 'example' => 't-123****', + ], + 'taskInstanceId' => [ + 'title' => '任务实例id', + 'description' => '', + 'type' => 'string', + 'example' => 'ti-123****', + ], + 'manualTaskId' => [ + 'title' => '手动任务id', + 'description' => '', + 'type' => 'string', + 'example' => 'mt-123****', + ], + 'manualTaskInstanceId' => [ + 'title' => '手动任务实例id', + 'description' => '', + 'type' => 'string', + 'example' => 'mti-123****', + ], + ], + 'example' => 'p-123****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1234567890\\",\\n \\"data\\": {\\n \\"inputId\\": \\"p-123****\\",\\n \\"inputIdType\\": \\"PROJECT\\",\\n \\"workspaceId\\": \\"workspace-123****\\",\\n \\"projectId\\": \\"p-123****\\",\\n \\"workflowId\\": \\"w-123****\\",\\n \\"workflowInstanceId\\": \\"wi-123****\\",\\n \\"taskId\\": \\"t-123****\\",\\n \\"taskInstanceId\\": \\"ti-123****\\",\\n \\"manualTaskId\\": \\"mt-123****\\",\\n \\"manualTaskInstanceId\\": \\"mti-123****\\"\\n }\\n}","type":"json"}]', + ], + 'GetInstanceLog' => [ + 'summary' => '获取实例的日志', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/instances/{instanceId}/log', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236258', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceVHPGXM', + 'FEATUREemapreduce3835LZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-111', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'p-12***', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ti-888***', + ], + ], + [ + 'name' => 'skipLineNum', + 'in' => 'query', + 'schema' => [ + 'title' => '跳过的行数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'limit', + 'in' => 'query', + 'schema' => [ + 'title' => '每次查询数量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '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' => '1234567890', + ], + 'data' => [ + 'title' => '返回值', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'lineNum' => [ + 'title' => '总行数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'message' => [ + 'title' => '日志', + 'description' => '', + 'type' => 'string', + 'example' => '"logs"', + ], + ], + 'example' => 'p-123****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1234567890\\",\\n \\"data\\": {\\n \\"lineNum\\": 1,\\n \\"message\\": \\"\\\\\\"logs\\\\\\"\\"\\n }\\n}","type":"json"}]', + ], + 'ListAlertGroups' => [ + 'summary' => '查询告警组列表', + 'path' => '/dolphinscheduler/v3/alert-groups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '235695', + 'abilityTreeNodes' => [ + 'FEATUREemapreduceYP2JJQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间 ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'w-lxyy60mpgpg****', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '请求的分页 token。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '一次获取的最大记录数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => [ + 'title' => '查询关键字。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => [ + 'title' => '项目ID。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'p-3q9jo749ne5****', + ], + ], + ], + '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' => [ + 'title' => '请求的分页 token。', + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'totalCount' => [ + 'title' => '记录总数。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'data' => [ + 'title' => '返回结果。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'groupName' => [ + 'title' => '告警组名称。', + 'description' => '', + 'type' => 'string', + 'example' => 'name', + ], + 'alertInstanceIds' => [ + 'title' => '告警实例ID。', + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'description' => [ + 'title' => '描述信息。', + 'description' => '', + 'type' => 'string', + 'example' => 'description', + ], + 'createTime' => [ + 'title' => '创建时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726834240000', + ], + 'updateTime' => [ + 'title' => '更新时间。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1726834240000', + ], + 'alertGroupId' => [ + 'title' => '告警组ID。', + 'description' => '', + 'type' => 'string', + 'example' => 'ag-8mklwpevk74****', + ], + ], + ], + ], + 'maxResults' => [ + 'title' => '一次获取的最大记录数。'."\n", + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"0\\",\\n \\"totalCount\\": 10,\\n \\"data\\": [\\n {\\n \\"groupName\\": \\"name\\",\\n \\"alertInstanceIds\\": \\"50\\",\\n \\"description\\": \\"description\\",\\n \\"createTime\\": 1726834240000,\\n \\"updateTime\\": 1726834240000,\\n \\"alertGroupId\\": \\"ag-8mklwpevk74****\\"\\n }\\n ],\\n \\"maxResults\\": 10\\n}","type":"json"}]', + ], + ], + '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', + ], + ], +]; -- cgit v1.2.3