diff options
Diffstat (limited to 'data/zh_cn/emrstudio/2024-04-30/api-docs.php')
| -rw-r--r-- | data/zh_cn/emrstudio/2024-04-30/api-docs.php | 5782 |
1 files changed, 2095 insertions, 3687 deletions
diff --git a/data/zh_cn/emrstudio/2024-04-30/api-docs.php b/data/zh_cn/emrstudio/2024-04-30/api-docs.php index 292ebef..aacd719 100644 --- a/data/zh_cn/emrstudio/2024-04-30/api-docs.php +++ b/data/zh_cn/emrstudio/2024-04-30/api-docs.php @@ -1,270 +1,216 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'EmrStudio', - 'version' => '2024-04-30', - ], + 'info' => ['style' => 'ROA', 'product' => 'EmrStudio', 'version' => '2024-04-30'], 'directories' => [ [ - 'id' => 192395, - 'title' => '项目管理', + 'children' => ['DescribeProject'], 'type' => 'directory', - 'children' => [ - 'DescribeProject', - 'ListProjects', - ], + 'title' => '项目管理', + 'id' => 330840, ], [ - 'id' => 192393, - 'title' => '工作流管理', + 'children' => ['ListWorkflowDirectories', 'RunWorkflow', 'DescribeWorkflow'], 'type' => 'directory', - 'children' => [ - 'ListWorkflowDirectories', - 'RunWorkflow', - 'ListWorkflows', - 'DescribeWorkflow', - 'UpdateWorkflow', - 'CreateWorkflow', - 'DeleteWorkflow', - ], + 'title' => '工作流管理', + 'id' => 330832, ], [ - 'id' => 192403, - 'title' => '工作流实例管理', + 'children' => ['DescribeWorkflowInstance', 'OperateWorkflowInstance'], 'type' => 'directory', - 'children' => [ - 'ListWorkflowInstances', - 'DescribeWorkflowInstance', - 'OperateWorkflowInstance', - ], + 'title' => '工作流实例管理', + 'id' => 330843, ], [ - 'id' => 192406, - 'title' => '手动任务管理', + 'children' => ['DescribeManualTask', 'ListManualTasks'], 'type' => 'directory', - 'children' => [ - 'DescribeManualTask', - 'ListManualTasks', - ], + 'title' => '手动任务管理', + 'id' => 330847, ], [ - 'id' => 192409, - 'title' => '手动任务实例管理', + 'children' => ['DescribeManualTaskInstance', 'ListManualTaskInstances'], 'type' => 'directory', - 'children' => [ - 'DescribeManualTaskInstance', - 'ListManualTaskInstances', - ], + 'title' => '手动任务实例管理', + 'id' => 330850, ], [ - 'id' => 192412, - 'title' => '任务管理', + 'children' => ['DescribeTask'], 'type' => 'directory', - 'children' => [ - 'ListTasks', - 'DescribeTask', - ], + 'title' => '任务管理', + 'id' => 330853, ], [ - 'id' => 192415, - 'title' => '任务实例管理', + 'children' => ['DescribeTaskInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeTaskInstance', - 'ListTaskInstances', - ], + 'title' => '任务实例管理', + 'id' => 330856, ], [ - 'id' => 197906, + 'children' => ['CreateWorkflow', 'DeleteWorkflow', 'DescribeId', 'GetInstanceLog', 'ListAlertGroups', 'ListProjects', 'ListResourceGroups', 'ListTaskInstances', 'ListTasks', 'ListWorkflowInstances', 'ListWorkflows', 'UpdateWorkflow'], 'title' => '其他', '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', - ], + 'CreateWorkflow' => [ + 'summary' => '创建工作流。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', + 'methods' => ['post'], + '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', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '220061', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-n72kong0832****'], + ], + [ 'name' => 'workspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => '工作流名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'taskRelationJson', + 'in' => 'query', + 'schema' => ['description' => '任务依赖关系json，包含工作流所有任务之间的依赖关系，preTaskId为上游任务id，postTaskId为下游任务id，此处指定的任务id为自定义id（不能为0），每一个任务需有唯一的id。如果任务节点没有上游任务，也需要增加一个preTaskId为0的依赖关系', 'type' => 'string', 'required' => true, 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]'], + ], + [ + 'name' => 'taskDefinitionJson', + 'in' => 'query', + 'schema' => ['description' => '任务定义json，包含工作流所有任务的描述信息', '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' => '目录ID', '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' => [ - 'title' => '工作空间id', - 'description' => '工作空间ID', + 'description' => '执行策略', 'type' => 'string', - 'required' => true, - 'example' => '1234', + 'required' => false, + 'enumValueTitles' => ['SERIAL_WAIT' => '串行等待', 'PARALLEL' => '并行'], + 'example' => 'PARALLEL', ], ], [ - 'name' => 'projectId', - 'in' => 'path', + 'name' => 'scheduleState', + 'in' => 'query', 'schema' => [ - 'description' => '项目ID', + 'description' => '调度状态', 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', + 'required' => false, + 'enumValueTitles' => ['OFFLINE' => '下线', 'ONLINE' => '上线'], + 'example' => 'OFFLINE', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '请求id', - 'type' => 'string', - 'example' => 'B897B94B-6754-5D09-AB8C-2E8186CCADC0', - ], - 'projectId' => [ - 'description' => '项目ID', - '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', - ], - ], - ], + [ + 'name' => 'scheduleStartTime', + 'in' => 'query', + 'schema' => ['description' => '调度起始时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 00:00:00'], ], - ], - '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"}]', - 'title' => '获取项目详情', - ], - 'ListProjects' => [ - 'summary' => '获取项目列表', - 'path' => '/dolphinscheduler/v3/projects', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'scheduleEndTime', + 'in' => 'query', + 'schema' => ['description' => '调度结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 00:00:00'], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '221489', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceBYNX2K', + [ + 'name' => 'cronExpr', + 'in' => 'query', + 'schema' => ['description' => '调度cron表达式', 'type' => 'string', 'required' => false, 'example' => '0 0 * * * ? *'], ], - ], - 'parameters' => [ [ - 'name' => 'nextToken', + 'name' => 'timeZone', + 'in' => 'query', + 'schema' => ['description' => '时区', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'], + ], + [ + 'name' => 'failureStrategy', 'in' => 'query', 'schema' => [ - 'description' => '下一次请求的分页token。', + 'description' => '失败策略', 'type' => 'string', 'required' => false, - 'example' => '123abc***', + 'enumValueTitles' => ['CONTINUE' => '继续', 'END' => '结束'], + 'example' => 'END', ], ], [ - 'name' => 'searchVal', + 'name' => 'alertStrategy', 'in' => 'query', 'schema' => [ - 'description' => '搜索值', + 'description' => '通知策略', 'type' => 'string', 'required' => false, - 'example' => 'test', + 'enumValueTitles' => ['ALL' => '成功或失败都发', 'SUCCESS' => '成功发', 'NONE' => '都不发', 'FAILURE' => '失败发'], + 'example' => 'NONE', ], ], [ - 'name' => 'maxResults', + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => ['description' => '告警组ID', 'type' => 'string', 'required' => false, 'example' => 'ag-v7n2gp3vv3j****'], + ], + [ + 'name' => 'workflowInstancePriority', 'in' => 'query', 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '工作流实例优先级', + 'type' => 'string', 'required' => false, - 'example' => '10', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], + 'example' => 'MEDIUM', ], ], [ - 'name' => 'workspaceId', + 'name' => 'resourceGroupId', 'in' => 'query', + 'schema' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'wg-acfmv4opbs****'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', + 'type' => 'object', + 'properties' => [ + 'taskRelationJsonValue' => ['type' => 'string'], + 'taskDefinitionJsonValue' => ['type' => 'string'], + ], ], ], ], @@ -275,67 +221,45 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'nextToken' => [ - 'title' => 'Id of the request', - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '123abc***', - ], + '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' => 'array', - 'items' => [ - 'description' => '项目', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '项目名称', - 'type' => 'string', - 'example' => 'project_name', - ], - 'description' => [ - 'description' => '项目描述', - 'type' => 'string', - 'example' => 'test', - ], - 'projectId' => [ - 'description' => '项目ID', - 'type' => 'string', - 'example' => 'p-3q9jo749ne5****', - ], - ], + 'type' => 'object', + 'properties' => [ + 'workflowId' => ['description' => '工作流ID', 'type' => 'string', 'example' => 'w-acfmv4opbs****'], ], ], - 'requestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'totalSize' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '创建工作流', + 'changeSet' => [ + ['createdAt' => '2024-09-06T09:45:51.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-09-05T13:24:25.000Z', 'description' => '请求参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emrstudio:CreateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取项目列表', ], - 'ListWorkflowDirectories' => [ - 'summary' => '查询工作流目录列表。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/directories', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteWorkflow' => [ + 'summary' => '删除工作流。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -343,79 +267,88 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '236078', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '219539', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], + ], + [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'title' => '项目 ID。'."\n", - 'description' => '项目 ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'workspaceId', - 'in' => 'query', + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => ['description' => '工作流ID', 'type' => 'string', 'required' => true, 'example' => 'w-3q9jo749ne5****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '工作空间 ID。', - 'description' => '工作空间 ID。', - 'type' => 'string', - 'required' => true, - 'example' => '12345', + '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'], + ], ], ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '请求的分页 token。', - 'description' => '请求的分页 token。', - 'type' => 'string', - 'required' => false, - 'example' => '0', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '删除工作流', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emrstudio:DeleteWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeId' => [ + 'summary' => '根据用户传入的编码ID，自动识别ID类型，并返回该ID关联的工作空间ID、项目ID、工作流ID、工作流实例ID、任务ID、任务实例ID、手动任务ID、手动任务实例ID等关联信息。', + 'path' => '/dolphinscheduler/v3/relatedIds', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '一次获取的最大记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + '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' => 'parentDirectoryId', + 'name' => 'id', 'in' => 'query', - 'schema' => [ - 'title' => '父目录ID。', - 'description' => '父目录ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'wd-y98v7non5d****', - ], + 'schema' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'required' => true, 'example' => 'p-123****'], ], [ - 'name' => 'directoryId', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'title' => '目录ID。', - 'description' => '目录ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'wd-y98v7non5dx****', - ], + 'schema' => ['title' => '工作空间id', 'description' => '工作空间id', 'type' => 'string', 'required' => true, 'example' => '111234'], ], ], 'responses' => [ @@ -425,90 +358,56 @@ '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' => '下一次请求的分页 token。', - 'type' => 'string', - 'example' => '1', - ], - 'totalCount' => [ - 'title' => '记录总数。', - 'description' => '记录总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890'], 'data' => [ - 'title' => '返回结果。', - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '目录名称。', - 'description' => '目录名称。', - 'type' => 'string', - 'example' => '目录名称。', - ], - 'workflowId' => [ - 'title' => '工作流ID。', - 'description' => '工作流ID。', - 'type' => 'string', - 'example' => 'w-lxyy60mpgpg****', - ], - 'parentDirectoryId' => [ - 'title' => '父目录ID。', - 'description' => '父目录ID。', - 'type' => 'string', - 'example' => 'wd-y98v7non5dx****', - ], - 'directoryId' => [ - 'title' => '目录ID。', - 'description' => '目录ID。', - 'type' => 'string', - 'example' => 'wd-y98v7non5dx****', - ], - 'projectId' => [ - 'title' => '项目ID。', - 'description' => '项目ID。', - 'type' => 'string', - 'example' => 'p-v7n28j0m4ol****', - ], - ], + 'title' => '返回值', + 'description' => '返回值', + 'type' => 'object', + 'properties' => [ + 'inputId' => ['title' => '输入id', 'description' => '输入id', 'type' => 'string', 'example' => 'p-123****'], + 'inputIdType' => ['title' => '输入id类型', 'description' => '输入id类型', 'type' => 'string', 'example' => 'PROJECT'], + 'workspaceId' => ['title' => '工作空间id', 'description' => '工作空间id', 'type' => 'string', 'example' => 'workspace-123****'], + 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => 'p-123****'], + 'workflowId' => ['title' => '工作流id', 'description' => '工作流id', 'type' => 'string', 'example' => 'w-123****'], + 'workflowInstanceId' => ['title' => '工作流实例id', 'description' => '工作流实例id', 'type' => 'string', 'example' => 'wi-123****'], + 'taskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => 't-123****'], + 'taskInstanceId' => ['title' => '任务实例id', 'description' => '任务实例id', 'type' => 'string', 'example' => 'ti-123****'], + 'manualTaskId' => ['title' => '手动任务id', 'description' => '手动任务id', 'type' => 'string', 'example' => 'mt-123****'], + 'manualTaskInstanceId' => ['title' => '手动任务实例id', 'description' => '手动任务实例id', 'type' => 'string', 'example' => 'mti-123****'], ], - ], - 'maxResults' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '一次获取的最大记录数。', - 'type' => 'string', - 'example' => '10', + 'example' => 'p-123****', ], ], ], ], ], - '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"}]', - 'title' => '获取工作流目录列表', - ], - 'RunWorkflow' => [ - 'summary' => '运行工作流。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/run-workflow', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'https', + '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"}]', + 'title' => '描述id相关信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeManualTask' => [ + 'summary' => '获取手动任务详情。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks/{manualTaskId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -516,191 +415,273 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '219779', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '221510', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'workflowId', - 'in' => 'query', - 'schema' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'required' => true, - 'example' => 'w-3q9jo749ne5****', - ], + 'name' => 'manualTaskId', + 'in' => 'path', + 'schema' => ['description' => '手动任务ID', 'type' => 'string', 'required' => true, 'example' => 'mt-3q9jo749ne5****'], ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '资源组ID', - 'type' => 'string', - 'required' => true, - 'example' => 'wg-acfmv4opbs****', + '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' => '手动任务ID', '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' => '项目ID', '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' => '资源ID列表', 'type' => 'string', 'example' => 'r-oy98v7n43el****'], + 'UpdateTime' => ['description' => '更新时间', 'type' => 'string', 'example' => '2024-03-27 00:00:00'], + 'ParentDirectoryId' => ['description' => '目录ID', 'type' => 'string', 'example' => 'mtd-oy98v7n43el****'], + ], ], ], - [ - 'name' => 'execType', - 'in' => 'query', - 'schema' => [ - 'description' => '运行类型', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'COMPLEMENT_DATA' => '补数', - 'START_PROCESS' => '运行工作流', + ], + '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"}]', + 'title' => '获取手动任务详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => 'START_PROCESS', ], ], + ], + ], + 'DescribeManualTaskInstance' => [ + 'summary' => '获取手动任务实例详情。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances/{manualTaskInstanceId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'failureStrategy', - 'in' => 'query', - 'schema' => [ - 'description' => '失败策略', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CONTINUE' => '继续', - 'END' => '结束', - ], - 'example' => 'END', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221526', + 'abilityTreeNodes' => ['FEATUREemapreduce3835LZ'], + ], + 'parameters' => [ [ - 'name' => 'alertStrategy', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '通知策略', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ALL' => '成功或失败都发', - 'SUCCESS' => '成功发', - 'NONE' => '都不发', - 'FAILURE' => '失败发', - ], - 'example' => 'NONE', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], ], [ - 'name' => 'alertGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '告警组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'ag-n72kong0832****', - ], + 'name' => 'manualTaskInstanceId', + 'in' => 'path', + 'schema' => ['description' => '手动任务实例ID', 'type' => 'string', 'required' => true, 'example' => 'mti-0k5vype05xm****'], ], [ - 'name' => 'workflowInstancePriority', - 'in' => 'query', + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作流实例优先级', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', + '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' => '手动任务实例ID', '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' => '外部应用ID', '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' => '资源组ID', 'type' => 'string', 'example' => 'wg-123abc***'], + 'EmrClusterId' => ['description' => 'EMR集群ID', 'type' => 'string', 'example' => 'c-b933c5aac7f7***'], ], - 'example' => 'MEDIUM', ], ], - [ - 'name' => 'startParams', - 'in' => 'query', - 'schema' => [ - 'description' => '启动参数', - 'type' => 'string', - 'required' => false, - 'example' => '{"key1":"value1"}', + ], + '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"}]', + 'title' => '获取手动任务实例详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeProject' => [ + 'summary' => '获取项目详情', + 'path' => '/dolphinscheduler/v3/projects/{projectId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => '空跑标识', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'AK' => [], ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218057', + 'abilityTreeNodes' => ['FEATUREemapreduceBYNX2K'], + ], + 'parameters' => [ [ - 'name' => 'complementDependentMode', + 'name' => 'workspaceId', 'in' => 'query', + 'schema' => ['title' => '工作空间id', 'description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '1234'], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '补数依赖模式', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF_MODE' => '关闭', - 'ALL_DEPENDENT' => '打开', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '请求id', 'description' => '请求id', 'type' => 'string', 'example' => 'B897B94B-6754-5D09-AB8C-2E8186CCADC0'], + 'projectId' => ['description' => '项目ID', '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'], ], - 'example' => 'OFF_MODE', ], ], - [ - 'name' => 'runMode', - 'in' => 'query', - 'schema' => [ - 'description' => '补数执行方式', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RUN_MODE_SERIAL' => '串行执行', - 'RUN_MODE_PARALLEL' => '并行执行', + ], + '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"}]', + 'title' => '获取项目详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'example' => 'RUN_MODE_PARALLEL', ], ], + ], + ], + 'DescribeTask' => [ + 'summary' => '获取任务详情', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}/tasks/{taskId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'expectedParallelismNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '补数并行度，范围1~7', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221586', + 'abilityTreeNodes' => ['FEATUREemapreduce61FDX5'], + ], + 'parameters' => [ [ - 'name' => 'scheduleTime', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '补数调度日期范围', - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-01 00:00:00,2024-01-02 00:00:00', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => ['description' => '工作流ID', 'type' => 'string', 'required' => true, 'example' => 'w-3q9jo749ne5****'], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => 't-3q9jo749ne5****'], ], ], 'responses' => [ @@ -710,109 +691,118 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'TaskId' => ['description' => '任务ID', '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' => '项目ID', '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', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], + 'example' => 'MEDIUM', ], - 'success' => [ - 'description' => '调用是否成功', - 'type' => 'boolean', - 'example' => 'true', + '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' => '资源ID列表', 'type' => 'string', 'example' => 'r-oy98v7n43el****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取任务详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', - 'title' => '运行工作流', ], - 'ListWorkflows' => [ - 'summary' => '获取工作流列表。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeTaskInstance' => [ + 'summary' => '获取任务实例详情', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowInstanceId}/taskInstances/{taskInstanceId}', + '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', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '221606', + 'abilityTreeNodes' => ['FEATUREemapreduce5Q1MGZ'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], - ], - [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => ['description' => '工作流实例ID', 'type' => 'string', 'required' => true, 'example' => 'wi-3q9jo749ne5****'], ], [ - 'name' => 'searchVal', - 'in' => 'query', - 'schema' => [ - 'description' => '搜索值', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'taskInstanceId', + 'in' => 'path', + 'schema' => ['description' => '任务实例ID', 'type' => 'string', 'required' => true, 'example' => 'ti-3q9jo749ne5****'], ], ], 'responses' => [ @@ -822,92 +812,72 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '返回结果', - 'type' => 'array', - 'items' => [ - 'description' => '工作流信息', - 'type' => 'object', - 'properties' => [ - 'workflowId' => [ - 'description' => '工作流ID', - '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' => '目录ID', - 'type' => 'string', - 'example' => 'wd-3q9jo749ne5****', - ], - ], - ], - ], - 'nextToken' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '123abc****', - ], - 'totalSize' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'requestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'TaskInstanceId' => ['description' => '任务实例ID', 'type' => 'string', 'example' => 'ti-3q9jo749ne5****'], + 'TaskInstanceName' => ['description' => '任务实例名称', 'type' => 'string', 'example' => 'test'], + 'TaskType' => ['description' => '任务类型', 'type' => 'string', 'example' => 'SHELL'], + 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 't-3q9jo749ne5****'], + 'TaskVersion' => ['description' => '任务版本', 'type' => 'string', 'example' => '1'], + 'WorkflowInstanceId' => ['description' => '工作流实例ID', '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' => '外部应用ID', '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' => '资源组ID', 'type' => 'string', 'example' => 'wg-123abc***'], + 'EmrClusterId' => ['description' => 'EMR集群ID', 'type' => 'string', 'example' => 'c-b933c5aac7f7***'], + 'DryRun' => ['description' => '空跑标识', 'type' => 'string', 'example' => '0'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取任务实例详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取工作流列表', ], 'DescribeWorkflow' => [ 'summary' => '获取工作流详情。', 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -915,40 +885,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '221441', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-n72kong0832****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-n72kong0832****'], ], [ 'name' => 'workflowId', 'in' => 'path', - 'schema' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'required' => true, - 'example' => 'w-n72kong0832****', - ], + 'schema' => ['description' => '工作流ID', 'type' => 'string', 'required' => true, 'example' => 'w-n72kong0832****'], ], ], 'responses' => [ @@ -958,65 +911,25 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '请求id', - 'type' => 'string', - 'example' => '611AD6E6-BFE3-5897-AA12-569F79DBAF9B', - ], + 'requestId' => ['description' => '请求id', 'type' => 'string', 'example' => '611AD6E6-BFE3-5897-AA12-569F79DBAF9B'], 'workflow' => [ 'description' => '工作流', 'type' => 'object', 'properties' => [ - 'workflowId' => [ - 'description' => '工作流ID', - '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' => '目录ID', - 'type' => 'string', - 'example' => 'wd-n72kong0832****', - ], - 'timeout' => [ - 'description' => '超时的时间，单位：分钟', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'workflowId' => ['description' => '工作流ID', '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' => '目录ID', 'type' => 'string', 'example' => 'wd-n72kong0832****'], + 'timeout' => ['description' => '超时的时间，单位：分钟', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'executionType' => [ 'description' => '执行策略', 'type' => 'string', - 'enumValueTitles' => [ - 'SERIAL_WAIT' => '串行等待', - 'PARALLEL' => '并行', - ], + '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', - ], + 'createTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01 00:00:00'], + 'updateTime' => ['description' => '更新时间', 'type' => 'string', 'example' => '2024-01-01 00:00:00'], ], ], 'tasks' => [ @@ -1026,27 +939,10 @@ 'description' => '任务对象', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '任务ID', - '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', - ], + 'taskId' => ['description' => '任务ID', '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'], ], ], ], @@ -1057,16 +953,8 @@ 'description' => '任务依赖关系', 'type' => 'object', 'properties' => [ - 'preTaskId' => [ - 'description' => '上游任务id，如果为0，则说明没有上游节点', - 'type' => 'string', - 'example' => 't-n72kong0832****', - ], - 'postTaskId' => [ - 'description' => '下游任务id', - 'type' => 'string', - 'example' => 't-n72kong0832****', - ], + 'preTaskId' => ['description' => '上游任务id，如果为0，则说明没有上游节点', 'type' => 'string', 'example' => 't-n72kong0832****'], + 'postTaskId' => ['description' => '下游任务id', 'type' => 'string', 'example' => 't-n72kong0832****'], ], ], ], @@ -1077,365 +965,94 @@ 'scheduleState' => [ 'description' => '调度状态', 'type' => 'string', - 'enumValueTitles' => [ - 'OFFLINE' => '下线', - 'ONLINE' => '上线', - ], + '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' => '调度cron表达式', - 'type' => 'string', - 'example' => '0 0 * * * ? *', - ], - 'timeZone' => [ - 'description' => '时区', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], + 'scheduleStartTime' => ['description' => '调度起始时间', 'type' => 'string', 'example' => '2024-01-01 00:00:00'], + 'scheduleEndTime' => ['description' => '调度结束时间', 'type' => 'string', 'example' => '2024-01-01 00:00:00'], + 'cronExpr' => ['description' => '调度cron表达式', 'type' => 'string', 'example' => '0 0 * * * ? *'], + 'timeZone' => ['description' => '时区', 'type' => 'string', 'example' => 'Asia/Shanghai'], 'failureStrategy' => [ 'description' => '失败策略', 'type' => 'string', - 'enumValueTitles' => [ - 'CONTINUE' => '继续', - 'END' => '结束', - ], + 'enumValueTitles' => ['CONTINUE' => '继续', 'END' => '结束'], 'example' => 'END', ], 'alertStrategy' => [ 'description' => '通知策略', 'type' => 'string', - 'enumValueTitles' => [ - 'ALL' => '成功或失败都发', - 'SUCCESS' => '成功发', - 'NONE' => '都不发', - 'FAILURE' => '失败发', - ], + 'enumValueTitles' => ['ALL' => '成功或失败都发', 'SUCCESS' => '成功发', 'NONE' => '都不发', 'FAILURE' => '失败发'], 'example' => 'NONE', ], - 'alertGroupId' => [ - 'description' => '告警组ID', - 'type' => 'string', - 'example' => 'ag-n72kong0832****', - ], + 'alertGroupId' => ['description' => '告警组ID', 'type' => 'string', 'example' => 'ag-n72kong0832****'], 'workflowInstancePriority' => [ 'description' => '工作流实例优先级', 'type' => 'string', - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], 'example' => 'MEDIUM', ], - 'resourceGroupId' => [ - 'description' => '资源组ID', - 'type' => 'string', - 'example' => 'wg-susqimrr649x****', - ], - 'emrClusterId' => [ - 'description' => 'EMR集群id', - 'type' => 'string', - 'example' => 'C-15F7AB9B53F1****', - ], + 'resourceGroupId' => ['description' => '资源组ID', 'type' => 'string', 'example' => 'wg-susqimrr649x****'], + 'emrClusterId' => ['description' => 'EMR集群id', 'type' => 'string', 'example' => 'C-15F7AB9B53F1****'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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"}]', 'title' => '获取工作流详情', - ], - 'UpdateWorkflow' => [ - 'summary' => '更新工作流。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + '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' => 'update', - 'abilityTreeCode' => '221014', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221702', + 'abilityTreeNodes' => ['FEATUREemapreduceVHPGXM'], ], 'parameters' => [ [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], - ], - [ - 'name' => 'workflowId', - 'in' => 'path', - 'schema' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'required' => true, - 'example' => 'w-n72kong0832****', - ], - ], - [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '工作流名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'taskRelationJson', - 'in' => 'query', - 'schema' => [ - 'description' => '任务依赖关系json，包含工作流所有任务之间的依赖关系，preTaskId为上游任务id，postTaskId为下游任务id，此处指定的任务id为自定义id（不能为0），每一个任务需有唯一的id。如果任务节点没有上游任务，也需要增加一个preTaskId为0的依赖关系', - 'type' => 'string', - 'required' => false, - 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', - ], - ], - [ - 'name' => 'taskDefinitionJson', - 'in' => 'query', - 'schema' => [ - 'description' => '任务定义json，包含工作流所有任务的描述信息', - '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' => '目录ID', - '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' => '调度cron表达式', - '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' => '告警组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'ag-n72kong0832****', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], ], [ - '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' => '资源组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'wg-acfmv4opbs****', - ], + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'taskRelationJsonValue' => [ - 'type' => 'string', - ], - 'taskDefinitionJsonValue' => [ - 'type' => 'string', - ], - ], - ], + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => ['description' => '工作流实例ID', 'type' => 'string', 'required' => true, 'example' => 'wf-3q9jo749ne5****'], ], ], 'responses' => [ @@ -1445,291 +1062,107 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', + 'workflowInstanceId' => ['description' => '工作流实例ID', 'type' => 'string', 'example' => 'wi-3q9jo749ne5****'], + 'workflowId' => ['description' => '工作流ID', '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' => '资源组ID', 'type' => 'string', 'example' => 'wg-susqimrr649x****'], + 'emrClusterId' => ['description' => 'EMR集群id', 'type' => 'string', 'example' => 'c-047fa6bbe732****'], + 'timeout' => ['description' => '超时的时间，单位：分钟', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'isComplementData' => ['description' => '是否为补数实例', 'type' => 'boolean', 'example' => 'false'], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'failureStrategy' => [ + 'description' => '失败策略', + 'type' => 'string', + 'enumValueTitles' => ['CONTINUE' => '继续', 'END' => '结束'], + 'example' => 'END', + ], + 'alertStrategy' => [ + 'description' => '通知策略', 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'enumValueTitles' => ['ALL' => '成功或失败都发', 'SUCCESS' => '成功发', 'NONE' => '都不发', 'FAILURE' => '失败发'], + 'example' => 'NONE', ], - 'success' => [ - 'description' => '调用是否成功', - 'type' => 'boolean', - 'example' => 'true', + 'alertGroupId' => ['description' => '告警组ID', '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', + '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"}]', + 'title' => '获取工作流实例详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', - 'title' => '更新工作流', ], - 'CreateWorkflow' => [ - 'summary' => '创建工作流。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => 'create', - 'abilityTreeCode' => '220061', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236258', + 'abilityTreeNodes' => ['FEATUREemapreduceVHPGXM', 'FEATUREemapreduce3835LZ'], ], 'parameters' => [ [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-n72kong0832****', - ], - ], - [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '工作流名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'taskRelationJson', - 'in' => 'query', - 'schema' => [ - 'description' => '任务依赖关系json，包含工作流所有任务之间的依赖关系，preTaskId为上游任务id，postTaskId为下游任务id，此处指定的任务id为自定义id（不能为0），每一个任务需有唯一的id。如果任务节点没有上游任务，也需要增加一个preTaskId为0的依赖关系', - 'type' => 'string', - 'required' => true, - 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', - ], - ], - [ - 'name' => 'taskDefinitionJson', - 'in' => 'query', - 'schema' => [ - 'description' => '任务定义json，包含工作流所有任务的描述信息', - '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' => '目录ID', - 'type' => 'string', - 'required' => false, - 'example' => 'wd-v7n2gp3vv3j****', - ], - ], - [ - 'name' => 'timeout', - 'in' => 'query', - 'schema' => [ - 'description' => '超时的时间，单位：分钟', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '工作空间id', 'description' => '工作空间id', 'type' => 'string', 'required' => true, 'example' => 'w-111'], ], [ - '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' => '调度cron表达式', - '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' => 'projectId', + 'in' => 'path', + 'schema' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'required' => true, 'example' => 'p-12***'], ], [ - 'name' => 'alertGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '告警组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'ag-v7n2gp3vv3j****', - ], + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '实例id', 'description' => '实例id', 'type' => 'string', 'required' => true, 'example' => 'ti-888***'], ], [ - 'name' => 'workflowInstancePriority', + 'name' => 'skipLineNum', 'in' => 'query', - 'schema' => [ - 'description' => '工作流实例优先级', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], - 'example' => 'MEDIUM', - ], + 'schema' => ['title' => '跳过的行数', 'description' => '跳过的行数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'limit', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'wg-acfmv4opbs****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'taskRelationJsonValue' => [ - 'type' => 'string', - ], - 'taskDefinitionJsonValue' => [ - 'type' => 'string', - ], - ], - ], + 'schema' => ['title' => '每次查询数量', 'description' => '每次查询数量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -1739,47 +1172,48 @@ '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', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890'], 'data' => [ - 'description' => '返回结果', + 'title' => '返回值', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'workflowId' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'example' => 'w-acfmv4opbs****', - ], + 'lineNum' => ['title' => '总行数', 'description' => '总行数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'message' => ['title' => '日志', 'description' => '日志', 'type' => 'string', 'example' => '"logs"'], ], + 'example' => 'p-123****', ], ], ], ], ], - '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"}]', - 'title' => '创建工作流', - ], - 'DeleteWorkflow' => [ - 'summary' => '删除工作流。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', - 'methods' => [ - 'delete', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1234567890\\",\\n \\"data\\": {\\n \\"lineNum\\": 1,\\n \\"message\\": \\"\\\\\\"logs\\\\\\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取任务实例日志', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:GetInstanceLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAlertGroups' => [ + 'summary' => '查询告警组列表。', + 'path' => '/dolphinscheduler/v3/alert-groups', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1787,42 +1221,35 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '219539', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '235695', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['title' => '工作空间 ID。', 'description' => '工作空间 ID。', 'type' => 'string', 'required' => true, 'example' => 'w-lxyy60mpgpg****'], ], [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['title' => '请求的分页 token。', 'description' => '请求的分页 token。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'workflowId', + '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' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'required' => true, - 'example' => 'w-3q9jo749ne5****', - ], + 'schema' => ['title' => '项目ID。', 'description' => '项目ID。', 'type' => 'string', 'required' => false, 'example' => 'p-3q9jo749ne5****'], ], ], 'responses' => [ @@ -1832,139 +1259,105 @@ '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', + 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['title' => '请求的分页 token。', 'description' => '请求的分页 token。', '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' => '告警实例ID。', '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' => '告警组ID。', 'type' => 'string', 'example' => 'ag-8mklwpevk74****'], + ], + 'description' => '', + ], ], + 'maxResults' => ['title' => '一次获取的最大记录数。'."\n", 'description' => '一次获取的最大记录数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取告警组列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListAlertGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', - 'title' => '删除工作流', ], - 'ListWorkflowInstances' => [ - 'summary' => '获取工作流实例列表。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflowInstances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListManualTaskInstances' => [ + 'summary' => '获取手动任务实例列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances', + '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', - ], + 'abilityTreeCode' => '221584', + 'abilityTreeNodes' => ['FEATUREemapreduce3835LZ'], ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'nextToken', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], ], [ - 'name' => 'maxResults', + 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '搜索值', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'startTime', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], + 'schema' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'required' => false, 'example' => '123abc***'], ], [ - 'name' => 'endTime', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], + 'schema' => ['description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'description' => '状态', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', - ], + 'schema' => ['description' => '状态', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'], ], [ - 'name' => 'workflowId', + 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'required' => false, - 'example' => 'w-3q9jo749ne5****', - ], + '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' => [ @@ -1974,360 +1367,113 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'nextToken' => [ - 'title' => 'Id of the request', - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'example' => '123abc***'], + 'totalSize' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'data' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ - 'description' => '工作流实例详情', + 'description' => '手动任务实例', 'type' => 'object', 'properties' => [ - 'workflowInstanceId' => [ - 'description' => '工作流实例ID', - 'type' => 'string', - 'example' => 'wi-3q9jo749ne5****', - ], - 'workflowId' => [ - 'description' => '工作流ID', - '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', - ], + 'ManualTaskInstanceId' => ['description' => '手动任务实例ID', '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' => '外部应用ID', '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' => '资源组ID', 'type' => 'string', 'example' => 'wg-3q9jo749ne5****'], + 'EmrClusterId' => ['description' => 'EMR集群ID', 'type' => 'string', 'example' => 'c-b933c5aac7f7***'], ], ], ], - 'requestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取手动任务实例列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取工作流实例列表', ], - 'DescribeWorkflowInstance' => [ - 'summary' => '获取工作流实例详情', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflowInstances/{workflowInstanceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListManualTasks' => [ + 'summary' => '获取手动任务列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks', + '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', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '221515', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'workflowInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '工作流实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'wf-3q9jo749ne5****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'workflowInstanceId' => [ - 'description' => '工作流实例ID', - 'type' => 'string', - 'example' => 'wi-3q9jo749ne5****', - ], - 'workflowId' => [ - 'description' => '工作流ID', - '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' => '资源组ID', - 'type' => 'string', - 'example' => 'wg-susqimrr649x****', - ], - 'emrClusterId' => [ - 'description' => 'EMR集群id', - 'type' => 'string', - 'example' => 'c-047fa6bbe732****', - ], - 'timeout' => [ - 'description' => '超时的时间，单位：分钟', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'isComplementData' => [ - 'description' => '是否为补数实例', - 'type' => 'boolean', - 'example' => 'false', - ], - 'requestId' => [ - 'description' => '请求ID', - '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' => '告警组ID', - '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', - ], - ], - ], + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], ], - ], - '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"}]', - 'title' => '获取工作流实例详情', - ], - 'OperateWorkflowInstance' => [ - 'summary' => '操作工作流实例', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/execute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '235673', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'required' => false, 'example' => '123abc***'], ], - ], - 'parameters' => [ [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'type' => 'object', - 'properties' => [ - 'workflowInstanceId' => [ - 'title' => '工作流实例ID。', - 'description' => '工作流实例ID。', - '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' => '执行类型。'."\n" - .'取值范围：'."\n" - .'- REPEAT_RUNNING：重复运行工作流。'."\n" - .'- RECOVER_SUSPENDED_PROCESS： 恢复暂停工作流。'."\n" - .'- START_FAILURE_TASK_PROCESS：从失败任务开始运行工作流。'."\n" - .'- STOP：停止工作流。'."\n" - .'- PAUSE： 暂停工作流。', - 'type' => 'string', - 'required' => false, - 'example' => 'PAUSE', - ], - ], - 'required' => false, - ], + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => ['description' => '搜索值', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'workspaceId', + 'name' => 'taskType', 'in' => 'query', - 'schema' => [ - 'title' => '工作空间 ID。', - 'description' => '工作空间 ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'w-lxyy60mpgpg****', - ], + 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'SHELL'], ], ], 'responses' => [ @@ -2337,80 +1483,107 @@ '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', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'example' => '123abc***'], + 'totalSize' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'data' => [ + 'description' => '返回结果', + 'type' => 'array', + 'items' => [ + 'description' => '手动任务', + 'type' => 'object', + 'properties' => [ + 'ManualTaskId' => ['description' => '手动任务ID', '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' => '项目ID', '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' => '资源ID列表', 'type' => 'string', 'example' => 'r-oy98v7n43el****'], + 'UpdateTime' => ['description' => '更新时间', 'type' => 'string', 'example' => '2024-03-27 00:00:00'], + 'ParentDirectoryId' => ['description' => '目录ID', 'type' => 'string', 'example' => 'mtd-oy98v7n43el****'], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取手动任务列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', - 'title' => '操作工作流', ], - 'DescribeManualTask' => [ - 'summary' => '获取手动任务详情。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks/{manualTaskId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListProjects' => [ + 'summary' => '获取项目列表', + 'path' => '/dolphinscheduler/v3/projects', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '221510', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221489', + 'abilityTreeNodes' => ['FEATUREemapreduceBYNX2K'], ], 'parameters' => [ [ - 'name' => 'workspaceId', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'required' => false, 'example' => '123abc***'], ], [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => ['description' => '搜索值', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'manualTaskId', - 'in' => 'path', - 'schema' => [ - 'description' => '手动任务ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mt-3q9jo749ne5****', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], ], ], 'responses' => [ @@ -2420,170 +1593,96 @@ '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' => '手动任务ID', - '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' => '项目ID', - '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' => '资源ID列表', - 'type' => 'string', - 'example' => 'r-oy98v7n43el****', - ], - 'UpdateTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'ParentDirectoryId' => [ - 'description' => '目录ID', - 'type' => 'string', - 'example' => 'mtd-oy98v7n43el****', + 'nextToken' => ['title' => 'Id of the request', 'description' => '下一次请求的分页token。', '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' => '项目ID', 'type' => 'string', 'example' => 'p-3q9jo749ne5****'], + ], + ], ], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'totalSize' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取项目列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取手动任务详情', ], - 'ListManualTasks' => [ - 'summary' => '获取手动任务列表。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListResourceGroups' => [ + 'summary' => '查询调度资源组列表', + 'path' => '/dolphinscheduler/v3/resourcegroups', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '221515', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236258', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], - ], - [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['title' => '工作空间 ID。', 'description' => '工作空间 ID。', 'type' => 'string', 'required' => true, 'example' => 'w-lxyy60mpgpg****'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['title' => '标记当前开始读取的位置。', 'description' => '标记当前开始读取的位置。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '一次获取的最大记录数。', 'description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'searchVal', + 'name' => 'resourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '搜索值', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '调度资源组名称。', 'description' => '调度资源组名称。', 'type' => 'string', 'required' => false, 'example' => 'name'], ], [ - 'name' => 'taskType', + 'name' => 'resourceGroupType', 'in' => 'query', - 'schema' => [ - 'description' => '任务类型', - 'type' => 'string', - 'required' => false, - 'example' => 'SHELL', - ], + 'schema' => ['title' => '调度资源组规格。'."\n" + .'取值范围：'."\n" + .'- CLUSTER_RESOURCE_GROUP：集群资源组。'."\n" + .'- CLUSTER_TEMPLATE_RESOURCE_GROUP：集群模版资源组。'."\n" + .'- DEFAULT_RESOURCE_GROUP：默认资源组。', 'description' => '调度资源组规格。'."\n" + .'取值范围：'."\n" + .'- CLUSTER_RESOURCE_GROUP：集群资源组。'."\n" + .'- CLUSTER_TEMPLATE_RESOURCE_GROUP：集群模版资源组。'."\n" + .'- DEFAULT_RESOURCE_GROUP：默认资源组。', 'type' => 'string', 'required' => false, 'example' => 'CLUSTER_RESOURCE_GROUP'], ], ], 'responses' => [ @@ -2593,264 +1692,109 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'example' => '1。'], + 'totalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'], 'data' => [ - 'description' => '返回结果', + 'description' => '返回结果。', 'type' => 'array', 'items' => [ - 'description' => '手动任务', + 'description' => '返回结果', 'type' => 'object', 'properties' => [ - 'ManualTaskId' => [ - 'description' => '手动任务ID', - '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' => '项目ID', - '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' => '资源ID列表', - 'type' => 'string', - 'example' => 'r-oy98v7n43el****', + 'resourceGroupId' => ['title' => '调度资源组ID。', 'description' => '调度资源组ID。', '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' => '节点规格，取值：'."\n" + .'- **EMR_W1_SMALL**：小型规格。'."\n" + .'- **EMR_W1_MEDIUM**：中型规格。'."\n" + .'- **EMR_W1_LARGE**：大型规格。', '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' => '工作空间ID。', 'type' => 'string', 'example' => '1200827。'], + 'workspaceName' => ['title' => '工作空间名称。', 'description' => '工作空间名称。', 'type' => 'string', 'example' => '数据开发1组。'], + ], + 'description' => '', + ], ], - 'UpdateTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', + 'associatedClusterTemplates' => [ + 'title' => '关联集群模版列表。', + 'description' => '关联集群模版列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'templateId' => ['title' => '集群模版ID。', 'description' => '集群模版ID。', 'type' => 'string', 'example' => '78723f0dc36。'], + 'templateName' => ['title' => '集群模版名称。', 'description' => '集群模版名称。', 'type' => 'string', 'example' => '模版1。'], + 'clusterType' => ['title' => '类型。', 'description' => '类型。', 'type' => 'string', 'example' => '集群类型，取值：'."\n" + .'- **DATALAKE**。'."\n" + .'- **CUSTOM**。'."\n" + .'- **HADOOP**。'], + ], + 'description' => '', + ], ], - 'ParentDirectoryId' => [ - 'description' => '目录ID', - 'type' => 'string', - 'example' => 'mtd-oy98v7n43el****', + 'associatedClusters' => [ + 'title' => '关联集群列表。', + 'description' => '关联集群列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'example' => 'c-3cd8ba94b36cxxxx'], + 'clusterName' => ['title' => '集群名称。', 'description' => '集群名称。', 'type' => 'string', 'example' => '离线集群。'], + 'clusterType' => ['title' => '类型。', 'description' => '类型。', 'type' => 'string', 'example' => '集群类型，取值：'."\n" + .'- **DATALAKE**。'."\n" + .'- **CUSTOM**。'."\n" + .'- **HADOOP**。'], + ], + 'description' => '', + ], ], ], ], ], + 'maxResults' => ['title' => '最大数量。', 'description' => '最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10。'], ], ], ], ], - '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"}]', - 'title' => '获取手动任务列表', - ], - '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' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], - ], - [ - 'name' => 'manualTaskInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '手动任务实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'mti-0k5vype05xm****', - ], - ], - [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => '手动任务实例ID', - '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' => '外部应用ID', - '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' => '资源组ID', - 'type' => 'string', - 'example' => 'wg-123abc***', - ], - 'EmrClusterId' => [ - 'description' => 'EMR集群ID', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], + '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"}]', + 'title' => '获取调度资源组列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - '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"}]', - 'title' => '获取手动任务实例详情', ], - 'ListManualTaskInstances' => [ - 'summary' => '获取手动任务实例列表。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListTaskInstances' => [ + 'summary' => '获取任务实例列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/taskInstances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2859,92 +1803,54 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '221584', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce3835LZ', - ], + 'abilityTreeCode' => '221613', + 'abilityTreeNodes' => ['FEATUREemapreduce5Q1MGZ'], ], 'parameters' => [ [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], + ], + [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'workspaceId', + 'name' => 'workflowInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => '工作流实例ID', 'type' => 'string', 'required' => false, 'example' => 'wi-3q9jo749ne5****'], ], [ 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'description' => '搜索值', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '搜索值', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'nextToken', + 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['description' => '状态', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'], ], [ - 'name' => 'maxResults', + 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00'], ], [ - 'name' => 'status', + 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'description' => '状态', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', - ], + 'schema' => ['description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00'], ], [ - 'name' => 'startTime', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], + 'schema' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'required' => false, 'example' => '123abc***'], ], [ - 'name' => 'endTime', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], + 'schema' => ['description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -2954,100 +1860,47 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9E3A7161-EB7B-172B-8D18-FFB06BA38***'], + 'nextToken' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'example' => '123abc***'], + 'totalSize' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'data' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ - 'description' => '手动任务实例', + 'description' => '任务实例', 'type' => 'object', 'properties' => [ - 'ManualTaskInstanceId' => [ - 'description' => '手动任务实例ID', - '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' => '外部应用ID', - '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' => '资源组ID', - 'type' => 'string', - 'example' => 'wg-3q9jo749ne5****', - ], - 'EmrClusterId' => [ - 'description' => 'EMR集群ID', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], + 'TaskInstanceId' => ['description' => '任务实例ID', 'type' => 'string', 'example' => 'ti-3q9jo749ne5****'], + 'TaskInstanceName' => ['description' => '任务实例名称', 'type' => 'string', 'example' => 'test'], + 'DryRun' => ['description' => '空跑标识', 'type' => 'string', 'example' => '0'], + 'EmrClusterId' => ['description' => 'EMR集群ID', 'type' => 'string', 'example' => 'c-b933c5aac7f7***'], + 'ResourceGroupId' => ['description' => '资源组ID', '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' => '外部应用ID', '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' => '工作流实例ID', 'type' => 'string', 'example' => 'wi-3q9jo749ne5****'], + 'TaskVersion' => ['description' => '任务版本', 'type' => 'string', 'example' => '1'], + 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 't-3q9jo749ne5****'], + 'TaskType' => ['description' => '任务类型', 'type' => 'string', 'example' => 'SHELL'], ], ], ], @@ -3055,21 +1908,29 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取任务实例列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取手动任务实例列表', ], 'ListTasks' => [ 'summary' => '获取任务列表。', 'path' => '/dolphinscheduler/v3/projects/{projectId}/tasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3079,80 +1940,43 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '221598', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce61FDX5', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce61FDX5'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'required' => false, 'example' => '123abc***'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '一次获取的最大记录数', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'description' => '搜索值', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '搜索值', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'taskType', 'in' => 'query', - 'schema' => [ - 'description' => '任务类型', - 'type' => 'string', - 'required' => false, - 'example' => 'SHELL', - ], + 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'SHELL'], ], [ 'name' => 'workflowId', 'in' => 'query', - 'schema' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'required' => false, - 'example' => 'w-n72kong0832****', - ], + 'schema' => ['description' => '工作流ID', 'type' => 'string', 'required' => false, 'example' => 'w-n72kong0832****'], ], ], 'responses' => [ @@ -3162,23 +1986,9 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'example' => '123abc***'], + 'totalSize' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'data' => [ 'description' => '返回结果', 'type' => 'array', @@ -3186,131 +1996,54 @@ 'description' => '任务', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID', - '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' => '项目ID', - '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', - ], + 'TaskId' => ['description' => '任务ID', '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' => '项目ID', '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', - ], + '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', - ], + 'FailRetryTimes' => ['description' => '失败重试次数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'FailRetryInterval' => ['description' => '失败重试间隔', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'TimeoutFlag' => [ 'description' => '超时告警标志', 'type' => 'string', - 'enumValueTitles' => [ - 'CLOSE' => '关闭', - 'OPEN' => '打开', - ], + 'enumValueTitles' => ['CLOSE' => '关闭', 'OPEN' => '打开'], 'example' => 'CLOSE', ], 'TimeoutNotifyStrategy' => [ 'description' => '超时策略', 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => '超时失败', - 'WARNFAILED' => '超时告警并失败', - 'WARN' => '超时告警', - ], + 'enumValueTitles' => ['FAILED' => '超时失败', 'WARNFAILED' => '超时告警并失败', 'WARN' => '超时告警'], 'example' => 'WARN', ], - 'Timeout' => [ - 'description' => '超时时长', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DelayTime' => [ - 'description' => '延时执行时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResourceIds' => [ - 'description' => '资源ID列表', - 'type' => 'string', - 'example' => 'r-3q9jo749ne5****', - ], + 'Timeout' => ['description' => '超时时长', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'DelayTime' => ['description' => '延时执行时间', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResourceIds' => ['description' => '资源ID列表', 'type' => 'string', 'example' => 'r-3q9jo749ne5****'], ], ], ], @@ -3318,21 +2051,29 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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"}]', 'title' => '获取任务列表', - ], - 'DescribeTask' => [ - 'summary' => '获取任务详情', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}/tasks/{taskId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListWorkflowDirectories' => [ + 'summary' => '查询工作流目录列表。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/directories', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3340,268 +2081,40 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '221586', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce61FDX5', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '236078', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], - ], - [ - 'name' => 'workflowId', - 'in' => 'path', - 'schema' => [ - 'description' => '工作流ID', - 'type' => 'string', - 'required' => true, - 'example' => 'w-3q9jo749ne5****', - ], - ], - [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], - ], - [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'description' => '任务ID', - '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' => '任务ID', - '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' => '项目ID', - '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' => '资源ID列表', - 'type' => 'string', - 'example' => 'r-oy98v7n43el****', - ], - ], - ], + 'schema' => ['title' => '项目 ID。'."\n", 'description' => '项目 ID。'."\n", 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], - ], - '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"}]', - 'title' => '获取任务详情', - ], - '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', + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['title' => '工作空间 ID。', 'description' => '工作空间 ID。', 'type' => 'string', 'required' => true, 'example' => '12345'], ], - ], - 'parameters' => [ [ - 'name' => 'workspaceId', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['title' => '请求的分页 token。', 'description' => '请求的分页 token。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['title' => '一次获取的最大记录数。', 'description' => '一次获取的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'workflowInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '工作流实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'wi-3q9jo749ne5****', - ], + 'name' => 'parentDirectoryId', + 'in' => 'query', + 'schema' => ['title' => '父目录ID。', 'description' => '父目录ID。', 'type' => 'string', 'required' => false, 'example' => 'wd-y98v7non5d****'], ], [ - 'name' => 'taskInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '任务实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ti-3q9jo749ne5****', - ], + 'name' => 'directoryId', + 'in' => 'query', + 'schema' => ['title' => '目录ID。', 'description' => '目录ID。', 'type' => 'string', 'required' => false, 'example' => 'wd-y98v7non5dx****'], ], ], 'responses' => [ @@ -3611,231 +2124,109 @@ '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' => '任务实例ID', - 'type' => 'string', - 'example' => 'ti-3q9jo749ne5****', - ], - 'TaskInstanceName' => [ - 'description' => '任务实例名称', - 'type' => 'string', - 'example' => 'test', - ], - 'TaskType' => [ - 'description' => '任务类型', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'TaskId' => [ - 'description' => '任务ID', - 'type' => 'string', - 'example' => 't-3q9jo749ne5****', - ], - 'TaskVersion' => [ - 'description' => '任务版本', - 'type' => 'string', - 'example' => '1', - ], - 'WorkflowInstanceId' => [ - 'description' => '工作流实例ID', - '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' => '外部应用ID', - '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' => '资源组ID', - 'type' => 'string', - 'example' => 'wg-123abc***', - ], - 'EmrClusterId' => [ - 'description' => 'EMR集群ID', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], - 'DryRun' => [ - 'description' => '空跑标识', - 'type' => 'string', - 'example' => '0', + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['title' => '下一次请求的分页 token。', 'description' => '下一次请求的分页 token。', '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' => '工作流ID。', 'type' => 'string', 'example' => 'w-lxyy60mpgpg****'], + 'parentDirectoryId' => ['title' => '父目录ID。', 'description' => '父目录ID。', 'type' => 'string', 'example' => 'wd-y98v7non5dx****'], + 'directoryId' => ['title' => '目录ID。', 'description' => '目录ID。', 'type' => 'string', 'example' => 'wd-y98v7non5dx****'], + 'projectId' => ['title' => '项目ID。', 'description' => '项目ID。', 'type' => 'string', 'example' => 'p-v7n28j0m4ol****'], + ], + 'description' => '', + ], ], + 'maxResults' => ['title' => '一次获取的最大记录数。', 'description' => '一次获取的最大记录数。', 'type' => 'string', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取工作流目录列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取任务实例详情', ], - 'ListTaskInstances' => [ - 'summary' => '获取任务实例列表。', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/taskInstances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + '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', - 'abilityTreeCode' => '221613', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5Q1MGZ', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221706', + 'abilityTreeNodes' => ['FEATUREemapreduceVHPGXM'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '工作空间ID', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '项目ID', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'workflowInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '工作流实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'wi-3q9jo749ne5****', - ], - ], - [ - 'name' => 'searchVal', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '搜索值', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'required' => false, 'example' => '123abc***'], ], [ - 'name' => 'status', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '状态', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00'], ], [ - 'name' => 'nextToken', + 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['description' => '状态', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'], ], [ - 'name' => 'maxResults', + 'name' => 'workflowId', 'in' => 'query', - 'schema' => [ - 'description' => '一次获取的最大记录数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '工作流ID', 'type' => 'string', 'required' => false, 'example' => 'w-3q9jo749ne5****'], ], ], 'responses' => [ @@ -3845,228 +2236,95 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9E3A7161-EB7B-172B-8D18-FFB06BA38***', - ], - 'nextToken' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '记录总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'nextToken' => ['title' => 'Id of the request', 'description' => '下一次请求的分页token。', 'type' => 'string', 'example' => '123abc***'], + 'totalSize' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'data' => [ 'description' => '返回结果', 'type' => 'array', 'items' => [ - 'description' => '任务实例', + 'description' => '工作流实例详情', 'type' => 'object', 'properties' => [ - 'TaskInstanceId' => [ - 'description' => '任务实例ID', - 'type' => 'string', - 'example' => 'ti-3q9jo749ne5****', - ], - 'TaskInstanceName' => [ - 'description' => '任务实例名称', - 'type' => 'string', - 'example' => 'test', - ], - 'DryRun' => [ - 'description' => '空跑标识', - 'type' => 'string', - 'example' => '0', - ], - 'EmrClusterId' => [ - 'description' => 'EMR集群ID', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID', - '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' => '外部应用ID', - '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' => '工作流实例ID', - 'type' => 'string', - 'example' => 'wi-3q9jo749ne5****', - ], - 'TaskVersion' => [ - 'description' => '任务版本', - 'type' => 'string', - 'example' => '1', - ], - 'TaskId' => [ - 'description' => '任务ID', - 'type' => 'string', - 'example' => 't-3q9jo749ne5****', - ], - 'TaskType' => [ - 'description' => '任务类型', - 'type' => 'string', - 'example' => 'SHELL', - ], + 'workflowInstanceId' => ['description' => '工作流实例ID', 'type' => 'string', 'example' => 'wi-3q9jo749ne5****'], + 'workflowId' => ['description' => '工作流ID', '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' => '请求ID', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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"}]', + 'title' => '获取工作流实例列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取任务实例列表', ], - 'ListResourceGroups' => [ - 'summary' => '查询调度资源组列表', - 'path' => '/dolphinscheduler/v3/resourcegroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + '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' => '236258', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'abilityTreeCode' => '221672', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'title' => '工作空间 ID。', - 'description' => '工作空间 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'w-lxyy60mpgpg****', - ], + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], ], [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '标记当前开始读取的位置。', - 'description' => '标记当前开始读取的位置。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ - 'name' => 'maxResults', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '一次获取的最大记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'required' => false, 'example' => '123abc***'], ], [ - 'name' => 'resourceGroupName', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'title' => '调度资源组名称。', - 'description' => '调度资源组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], + 'schema' => ['description' => '一次获取的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ - 'name' => 'resourceGroupType', + 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'title' => '调度资源组规格。'."\n" - .'取值范围：'."\n" - .'- CLUSTER_RESOURCE_GROUP：集群资源组。'."\n" - .'- CLUSTER_TEMPLATE_RESOURCE_GROUP：集群模版资源组。'."\n" - .'- DEFAULT_RESOURCE_GROUP：默认资源组。', - 'description' => '调度资源组规格。'."\n" - .'取值范围：'."\n" - .'- CLUSTER_RESOURCE_GROUP：集群资源组。'."\n" - .'- CLUSTER_TEMPLATE_RESOURCE_GROUP：集群模版资源组。'."\n" - .'- DEFAULT_RESOURCE_GROUP：默认资源组。', - 'type' => 'string', - 'required' => false, - 'example' => 'CLUSTER_RESOURCE_GROUP', - ], + 'schema' => ['description' => '搜索值', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], 'responses' => [ @@ -4076,247 +2334,99 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '下一次请求的分页token。', - 'type' => 'string', - 'example' => '1。', - ], - 'totalCount' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], 'data' => [ - 'description' => '返回结果。', + 'description' => '返回结果', 'type' => 'array', 'items' => [ - 'description' => '返回结果', + 'description' => '工作流信息', 'type' => 'object', 'properties' => [ - 'resourceGroupId' => [ - 'title' => '调度资源组ID。', - 'description' => '调度资源组ID。', - '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' => '节点规格，取值：'."\n" - .'- **EMR_W1_SMALL**：小型规格。'."\n" - .'- **EMR_W1_MEDIUM**：中型规格。'."\n" - .'- **EMR_W1_LARGE**：大型规格。', - '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' => '工作空间ID。', - 'type' => 'string', - 'example' => '1200827。', - ], - 'workspaceName' => [ - 'title' => '工作空间名称。', - 'description' => '工作空间名称。', - 'type' => 'string', - 'example' => '数据开发1组。', - ], - ], - ], - ], - 'associatedClusterTemplates' => [ - 'title' => '关联集群模版列表。', - 'description' => '关联集群模版列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'templateId' => [ - 'title' => '集群模版ID。', - 'description' => '集群模版ID。', - 'type' => 'string', - 'example' => '78723f0dc36。', - ], - 'templateName' => [ - 'title' => '集群模版名称。', - 'description' => '集群模版名称。', - 'type' => 'string', - 'example' => '模版1。', - ], - 'clusterType' => [ - 'title' => '类型。', - 'description' => '类型。', - 'type' => 'string', - 'example' => '集群类型，取值：'."\n" - .'- **DATALAKE**。'."\n" - .'- **CUSTOM**。'."\n" - .'- **HADOOP**。', - ], - ], - ], - ], - 'associatedClusters' => [ - 'title' => '关联集群列表。', - 'description' => '关联集群列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'title' => '集群ID。', - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'c-3cd8ba94b36cxxxx', - ], - 'clusterName' => [ - 'title' => '集群名称。', - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '离线集群。', - ], - 'clusterType' => [ - 'title' => '类型。', - 'description' => '类型。', - 'type' => 'string', - 'example' => '集群类型，取值：'."\n" - .'- **DATALAKE**。'."\n" - .'- **CUSTOM**。'."\n" - .'- **HADOOP**。', - ], - ], - ], - ], + 'workflowId' => ['description' => '工作流ID', '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' => '目录ID', 'type' => 'string', 'example' => 'wd-3q9jo749ne5****'], ], ], ], - 'maxResults' => [ - 'title' => '最大数量。', - 'description' => '最大数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10。', - ], + 'nextToken' => ['description' => '下一次请求的分页token。', 'type' => 'string', 'example' => '123abc****'], + 'totalSize' => ['description' => '记录总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'requestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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"}]', + 'title' => '获取工作流列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取调度资源组列表', ], - 'DescribeId' => [ - 'summary' => '根据用户传入的编码ID，自动识别ID类型，并返回该ID关联的工作空间ID、项目ID、工作流ID、工作流实例ID、任务ID、任务实例ID、手动任务ID、手动任务实例ID等关联信息。', - 'path' => '/dolphinscheduler/v3/relatedIds', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'OperateWorkflowInstance' => [ + 'summary' => '操作工作流实例', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/execute', + 'methods' => ['post'], + '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', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '235673', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ - 'name' => 'id', - 'in' => 'query', + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID。', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'id', - 'description' => 'id', - 'type' => 'string', - 'required' => true, - 'example' => 'p-123****', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'workflowInstanceId' => ['title' => '工作流实例ID。', 'description' => '工作流实例ID。', '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' => '执行类型。'."\n" + .'取值范围：'."\n" + .'- REPEAT_RUNNING：重复运行工作流。'."\n" + .'- RECOVER_SUSPENDED_PROCESS： 恢复暂停工作流。'."\n" + .'- START_FAILURE_TASK_PROCESS：从失败任务开始运行工作流。'."\n" + .'- STOP：停止工作流。'."\n" + .'- PAUSE： 暂停工作流。', 'type' => 'string', 'required' => false, 'example' => 'PAUSE'], + ], + 'required' => false, ], ], [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'title' => '工作空间id', - 'description' => '工作空间id', - 'type' => 'string', - 'required' => true, - 'example' => '111234', - ], + 'schema' => ['title' => '工作空间 ID。', 'description' => '工作空间 ID。', 'type' => 'string', 'required' => false, 'example' => 'w-lxyy60mpgpg****'], ], ], 'responses' => [ @@ -4326,181 +2436,158 @@ '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' => '输入id', - 'type' => 'string', - 'example' => 'p-123****', - ], - 'inputIdType' => [ - 'title' => '输入id类型', - 'description' => '输入id类型', - 'type' => 'string', - 'example' => 'PROJECT', - ], - 'workspaceId' => [ - 'title' => '工作空间id', - 'description' => '工作空间id', - 'type' => 'string', - 'example' => 'workspace-123****', - ], - 'projectId' => [ - 'title' => '项目id', - 'description' => '项目id', - 'type' => 'string', - 'example' => 'p-123****', - ], - 'workflowId' => [ - 'title' => '工作流id', - 'description' => '工作流id', - 'type' => 'string', - 'example' => 'w-123****', - ], - 'workflowInstanceId' => [ - 'title' => '工作流实例id', - 'description' => '工作流实例id', - 'type' => 'string', - 'example' => 'wi-123****', - ], - 'taskId' => [ - 'title' => '任务id', - 'description' => '任务id', - 'type' => 'string', - 'example' => 't-123****', - ], - 'taskInstanceId' => [ - 'title' => '任务实例id', - 'description' => '任务实例id', - 'type' => 'string', - 'example' => 'ti-123****', - ], - 'manualTaskId' => [ - 'title' => '手动任务id', - 'description' => '手动任务id', - 'type' => 'string', - 'example' => 'mt-123****', - ], - 'manualTaskInstanceId' => [ - 'title' => '手动任务实例id', - 'description' => '手动任务实例id', - 'type' => 'string', - 'example' => 'mti-123****', - ], - ], - 'example' => 'p-123****', - ], + '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', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '操作工作流', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:OperateWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '描述id相关信息', ], - 'GetInstanceLog' => [ - 'summary' => '获取实例的日志', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/instances/{instanceId}/log', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RunWorkflow' => [ + 'summary' => '运行工作流。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/run-workflow', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236258', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceVHPGXM', - 'FEATUREemapreduce3835LZ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '219779', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '12345'], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], + ], + [ + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => ['description' => '工作流ID', 'type' => 'string', 'required' => true, 'example' => 'w-3q9jo749ne5****'], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID', 'type' => 'string', 'required' => true, 'example' => 'wg-acfmv4opbs****'], + ], + [ + 'name' => 'execType', + 'in' => 'query', 'schema' => [ - 'title' => '工作空间id', - 'description' => '工作空间id', + 'description' => '运行类型', 'type' => 'string', - 'required' => true, - 'example' => 'w-111', + 'required' => false, + 'enumValueTitles' => ['COMPLEMENT_DATA' => '补数', 'START_PROCESS' => '运行工作流'], + 'example' => 'START_PROCESS', ], ], [ - 'name' => 'projectId', - 'in' => 'path', + 'name' => 'failureStrategy', + 'in' => 'query', 'schema' => [ - 'title' => '项目id', - 'description' => '项目id', + 'description' => '失败策略', 'type' => 'string', - 'required' => true, - 'example' => 'p-12***', + 'required' => false, + 'enumValueTitles' => ['CONTINUE' => '继续', 'END' => '结束'], + 'example' => 'END', ], ], [ - 'name' => 'instanceId', - 'in' => 'path', + 'name' => 'alertStrategy', + 'in' => 'query', 'schema' => [ - 'title' => '实例id', - 'description' => '实例id', + 'description' => '通知策略', 'type' => 'string', - 'required' => true, - 'example' => 'ti-888***', + 'required' => false, + 'enumValueTitles' => ['ALL' => '成功或失败都发', 'SUCCESS' => '成功发', 'NONE' => '都不发', 'FAILURE' => '失败发'], + 'example' => 'NONE', ], ], [ - 'name' => 'skipLineNum', + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => ['description' => '告警组ID', 'type' => 'string', 'required' => false, 'example' => 'ag-n72kong0832****'], + ], + [ + 'name' => 'workflowInstancePriority', 'in' => 'query', 'schema' => [ - 'title' => '跳过的行数', - 'description' => '跳过的行数', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '工作流实例优先级', + 'type' => 'string', 'required' => false, - 'example' => '1', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], + 'example' => 'MEDIUM', ], ], [ - 'name' => 'limit', + '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' => [ - 'title' => '每次查询数量', - 'description' => '每次查询数量', - 'type' => 'integer', - 'format' => 'int64', + 'description' => '补数依赖模式', + 'type' => 'string', 'required' => false, - 'example' => '1', + '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' => '补数并行度，范围1~7', '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 => [ @@ -4509,56 +2596,35 @@ '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****', - ], + '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', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '运行工作流', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:RunWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1234567890\\",\\n \\"data\\": {\\n \\"lineNum\\": 1,\\n \\"message\\": \\"\\\\\\"logs\\\\\\"\\"\\n }\\n}","type":"json"}]', - 'title' => '获取任务实例日志', ], - 'ListAlertGroups' => [ - 'summary' => '查询告警组列表。', - 'path' => '/dolphinscheduler/v3/alert-groups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateWorkflow' => [ + 'summary' => '更新工作流。', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4566,67 +2632,156 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '235695', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '221014', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => ['description' => '工作流ID', 'type' => 'string', 'required' => true, 'example' => 'w-n72kong0832****'], + ], + [ 'name' => 'workspaceId', 'in' => 'query', + 'schema' => ['description' => '工作空间ID', 'type' => 'string', 'required' => true, 'example' => '123***'], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => '工作流名称', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'taskRelationJson', + 'in' => 'query', + 'schema' => ['description' => '任务依赖关系json，包含工作流所有任务之间的依赖关系，preTaskId为上游任务id，postTaskId为下游任务id，此处指定的任务id为自定义id（不能为0），每一个任务需有唯一的id。如果任务节点没有上游任务，也需要增加一个preTaskId为0的依赖关系', 'type' => 'string', 'required' => false, 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]'], + ], + [ + 'name' => 'taskDefinitionJson', + 'in' => 'query', + 'schema' => ['description' => '任务定义json，包含工作流所有任务的描述信息', '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' => '目录ID', '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' => [ - 'title' => '工作空间 ID。', - 'description' => '工作空间 ID。', + 'description' => '执行策略', 'type' => 'string', - 'required' => true, - 'example' => 'w-lxyy60mpgpg****', + 'required' => false, + 'enumValueTitles' => ['SERIAL_WAIT' => '串行等待', 'PARALLEL' => '并行'], + 'example' => 'PARALLEL', ], ], [ - 'name' => 'nextToken', + 'name' => 'scheduleState', 'in' => 'query', 'schema' => [ - 'title' => '请求的分页 token。', - 'description' => '请求的分页 token。', + 'description' => '调度状态', 'type' => 'string', 'required' => false, - 'example' => '0', + 'enumValueTitles' => ['OFFLINE' => '下线', 'ONLINE' => '上线'], + 'example' => 'OFFLINE', ], ], [ - 'name' => 'maxResults', + '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' => '调度cron表达式', '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' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '一次获取的最大记录数。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '失败策略', + 'type' => 'string', 'required' => false, - 'example' => '10', + 'enumValueTitles' => ['CONTINUE' => '继续', 'END' => '结束'], + 'example' => 'END', ], ], [ - 'name' => 'searchVal', + 'name' => 'alertStrategy', 'in' => 'query', 'schema' => [ - 'title' => '查询关键字。', - 'description' => '查询关键字。', + 'description' => '通知策略', 'type' => 'string', 'required' => false, - 'example' => 'name', + 'enumValueTitles' => ['ALL' => '成功或失败都发', 'SUCCESS' => '成功发', 'NONE' => '都不发', 'FAILURE' => '失败发'], + 'example' => 'NONE', ], ], [ - 'name' => 'projectId', - 'in' => 'path', + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => ['description' => '告警组ID', 'type' => 'string', 'required' => false, 'example' => 'ag-n72kong0832****'], + ], + [ + 'name' => 'workflowInstancePriority', + 'in' => 'query', 'schema' => [ - 'title' => '项目ID。', - 'description' => '项目ID。', + 'description' => '工作流实例优先级', 'type' => 'string', 'required' => false, - 'example' => 'p-3q9jo749ne5****', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], + 'example' => 'MEDIUM', + ], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID', 'type' => 'string', 'required' => false, 'example' => 'wg-acfmv4opbs****'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'taskRelationJsonValue' => ['type' => 'string'], + 'taskDefinitionJsonValue' => ['type' => 'string'], + ], ], ], ], @@ -4637,135 +2792,388 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'title' => '请求的分页 token。', - 'description' => '请求的分页 token。', - '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' => '告警实例ID。', - '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' => '告警组ID。', - 'type' => 'string', - 'example' => 'ag-8mklwpevk74****', - ], - ], - ], - ], - 'maxResults' => [ - 'title' => '一次获取的最大记录数。'."\n", - 'description' => '一次获取的最大记录数。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + '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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => '更新工作流', + 'changeSet' => [ + ['createdAt' => '2024-09-06T09:45:50.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-09-05T13:24:25.000Z', 'description' => '请求参数发生变更'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emrstudio:UpdateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - '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"}]', - 'title' => '获取告警组列表', ], ], 'endpoints' => [ + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.cn-shenzhen.aliyuncs.com', 'endpoint' => 'emrstudio.cn-shenzhen.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.cn-beijing.aliyuncs.com', 'endpoint' => 'emrstudio.cn-beijing.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.cn-shanghai.aliyuncs.com', 'endpoint' => 'emrstudio.cn-shanghai.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.cn-hongkong.aliyuncs.com', 'endpoint' => 'emrstudio.cn-hongkong.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.ap-southeast-1.aliyuncs.com', 'endpoint' => 'emrstudio.ap-southeast-1.aliyuncs.com', 'vpc' => 'emrstudio-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.ap-southeast-3.aliyuncs.com', 'endpoint' => 'emrstudio.ap-southeast-3.aliyuncs.com', 'vpc' => 'emrstudio-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'emrstudio.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.cn-hangzhou.aliyuncs.com', 'endpoint' => 'emrstudio.cn-hangzhou.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'emrstudio.cn-chengdu.aliyuncs.com', 'endpoint' => 'emrstudio.cn-chengdu.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'emrstudio.us-west-1.aliyuncs.com', 'endpoint' => 'emrstudio.us-west-1.aliyuncs.com', 'vpc' => 'emrstudio-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'emrstudio.eu-central-1.aliyuncs.com', 'endpoint' => 'emrstudio.eu-central-1.aliyuncs.com', 'vpc' => 'emrstudio-vpc.eu-central-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'OperationDenied', 'message' => 'This product will be discontinued soon and is only available to existing customers.', 'http_code' => 403, 'description' => '本产品即将下线，仅支持存量客户使用'], + ], + 'changeSet' => [ [ - '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', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateWorkflow'], + ['description' => '请求参数发生变更', 'api' => 'UpdateWorkflow'], + ], + 'createdAt' => '2024-09-06T09:45:57.000Z', + 'description' => '', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'emrstudio.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateWorkflow'], + ['description' => '请求参数发生变更', 'api' => 'UpdateWorkflow'], + ], + 'createdAt' => '2024-09-05T13:24:31.000Z', + 'description' => '', ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'emrstudio.cn-hongkong.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'EmrStudio', + 'productName' => '开源大数据平台 E-MapReduce', + 'ramCodes' => ['emrstudio'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DeleteWorkflow', + 'description' => '删除工作流', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emrstudio:DeleteWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListResourceGroups', + 'description' => '获取调度资源组列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeProject', + 'description' => '获取项目详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListProjects', + 'description' => '获取项目列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateWorkflow', + 'description' => '更新工作流', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emrstudio:UpdateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkflows', + 'description' => '获取工作流列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTasks', + 'description' => '获取任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeTask', + 'description' => '获取任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RunWorkflow', + 'description' => '运行工作流', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:RunWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetInstanceLog', + 'description' => '获取任务实例日志', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:GetInstanceLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateWorkflow', + 'description' => '创建工作流', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emrstudio:CreateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListManualTasks', + 'description' => '获取手动任务列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeWorkflow', + 'description' => '获取工作流详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeWorkflowInstance', + 'description' => '获取工作流实例详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeManualTaskInstance', + 'description' => '获取手动任务实例详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeId', + 'description' => '描述id相关信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkflowDirectories', + 'description' => '获取工作流目录列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeTaskInstance', + 'description' => '获取任务实例详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OperateWorkflowInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:OperateWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListManualTaskInstances', + 'description' => '获取手动任务实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeManualTask', + 'description' => '获取手动任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlertGroups', + 'description' => '获取告警组列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListAlertGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkflowInstances', + 'description' => '获取工作流实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTaskInstances', + 'description' => '获取任务实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |