diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/emrstudio/2024-04-30/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/emrstudio/2024-04-30/api-docs.php')
| -rw-r--r-- | data/en_us/emrstudio/2024-04-30/api-docs.php | 5932 |
1 files changed, 2252 insertions, 3680 deletions
diff --git a/data/en_us/emrstudio/2024-04-30/api-docs.php b/data/en_us/emrstudio/2024-04-30/api-docs.php index a83dbd9..3d58d35 100644 --- a/data/en_us/emrstudio/2024-04-30/api-docs.php +++ b/data/en_us/emrstudio/2024-04-30/api-docs.php @@ -1,339 +1,269 @@ <?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' => null, + 'children' => ['DescribeProject'], 'type' => 'directory', - 'children' => [ - 'DescribeProject', - 'ListProjects', - ], + 'title' => 'Project management', ], [ - 'id' => 192393, - 'title' => null, + 'children' => ['ListWorkflowDirectories', 'RunWorkflow', 'DescribeWorkflow'], 'type' => 'directory', - 'children' => [ - 'ListWorkflowDirectories', - 'RunWorkflow', - 'ListWorkflows', - 'DescribeWorkflow', - 'UpdateWorkflow', - 'CreateWorkflow', - 'DeleteWorkflow', - ], + 'title' => 'Workflow management', ], [ - 'id' => 192403, - 'title' => null, + 'children' => ['DescribeWorkflowInstance', 'OperateWorkflowInstance'], 'type' => 'directory', - 'children' => [ - 'ListWorkflowInstances', - 'DescribeWorkflowInstance', - 'OperateWorkflowInstance', - ], + 'title' => 'Workflow instance management', ], [ - 'id' => 192406, - 'title' => null, + 'children' => ['DescribeManualTask', 'ListManualTasks'], 'type' => 'directory', - 'children' => [ - 'DescribeManualTask', - 'ListManualTasks', - ], + 'title' => 'Manual task management', ], [ - 'id' => 192409, - 'title' => null, + 'children' => ['DescribeManualTaskInstance', 'ListManualTaskInstances'], 'type' => 'directory', - 'children' => [ - 'DescribeManualTaskInstance', - 'ListManualTaskInstances', - ], + 'title' => 'Manual task instance management', ], [ - 'id' => 192412, - 'title' => null, + 'children' => ['DescribeTask'], 'type' => 'directory', - 'children' => [ - 'ListTasks', - 'DescribeTask', - ], + 'title' => 'Task management', ], [ - 'id' => 192415, - 'title' => null, + 'children' => ['DescribeTaskInstance'], 'type' => 'directory', - 'children' => [ - 'DescribeTaskInstance', - 'ListTaskInstances', - ], + 'title' => 'Task instance management', ], [ - 'id' => 197906, - 'title' => null, + 'children' => ['CreateWorkflow', 'DeleteWorkflow', 'DescribeId', 'GetInstanceLog', 'ListAlertGroups', 'ListProjects', 'ListResourceGroups', 'ListTaskInstances', 'ListTasks', 'ListWorkflowInstances', 'ListWorkflows', 'UpdateWorkflow'], + 'title' => 'Others', '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' => 'Creates a workflow.', + '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' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-n72kong0832****', 'title' => ''], + ], + [ 'name' => 'workspaceId', 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'taskRelationJson', + 'in' => 'query', + 'schema' => ['description' => 'The task dependency JSON that contains the dependencies between all tasks in the workflow. preTaskId specifies the upstream task ID, and postTaskId specifies the downstream task ID. The task IDs specified here are custom IDs that cannot be 0, and each task must have a unique ID. If a task node has no upstream task, add a dependency with preTaskId set to 0.', 'type' => 'string', 'required' => true, 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', 'title' => ''], + ], + [ + 'name' => 'taskDefinitionJson', + 'in' => 'query', + 'schema' => ['description' => 'The task definition JSON that contains the description of all tasks in the workflow.', 'type' => 'string', 'required' => true, 'example' => ' [{"taskId":"t1","name":"t1","taskParams":{"rawScript":"echo 1"},"taskType":"SHELL"}]', 'title' => ''], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'workflowParams', + 'in' => 'query', + 'schema' => ['description' => 'The workflow parameters.', 'type' => 'string', 'required' => false, 'example' => ' [{"prop":"key1","value":"value1"}]', 'title' => ''], + ], + [ + 'name' => 'parentDirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'The folder ID.', 'type' => 'string', 'required' => false, 'example' => 'wd-v7n2gp3vv3j****', 'title' => ''], + ], + [ + 'name' => 'timeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'executionType', + 'in' => 'query', 'schema' => [ - 'title' => '工作空间id', - 'description' => '', + 'description' => 'The execution policy. Valid values:', + 'enumValueTitles' => ['SERIAL_WAIT' => 'sequential execution with waiting.', 'PARALLEL' => 'concurrent execution.'], 'type' => 'string', - 'required' => true, - 'example' => '1234', + 'required' => false, + 'example' => 'PARALLEL', + 'title' => '', ], ], [ - 'name' => 'projectId', - 'in' => 'path', + 'name' => 'scheduleState', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The scheduling status. Valid values:', + 'enumValueTitles' => ['OFFLINE' => 'offline.', 'ONLINE' => 'online.'], 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', + 'required' => false, + 'example' => 'OFFLINE', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => '请求id', - 'description' => '', - 'type' => 'string', - 'example' => 'B897B94B-6754-5D09-AB8C-2E8186CCADC0', - ], - 'projectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'p-3q9jo749ne5****', - ], - 'name' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test_project_name', - ], - 'description' => [ - 'title' => '项目描述', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'this is a project description', - ], - ], - ], + [ + 'name' => 'scheduleStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduling start time.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 00:00:00', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B897B94B-6754-5D09-AB8C-2E8186CCADC0\\",\\n \\"projectId\\": \\"p-3q9jo749ne5****\\",\\n \\"name\\": \\"test_project_name\\",\\n \\"description\\": \\"this is a project description\\"\\n}","type":"json"}]', - ], - 'ListProjects' => [ - 'summary' => '获取项目详情', - 'path' => '/dolphinscheduler/v3/projects', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'scheduleEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduling end time.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 00:00:00', 'title' => ''], ], - ], - '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' => 'The scheduling cron expression.', 'type' => 'string', 'required' => false, 'example' => '0 0 * * * ? *', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'nextToken', + 'name' => 'timeZone', + 'in' => 'query', + 'schema' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', 'title' => ''], + ], + [ + 'name' => 'failureStrategy', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The failure policy. Valid values:', + 'enumValueTitles' => ['CONTINUE' => 'continue.', 'END' => 'end.'], 'type' => 'string', 'required' => false, - 'example' => '123abc***', + 'example' => 'END', + 'title' => '', ], ], [ - 'name' => 'searchVal', + 'name' => 'alertStrategy', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The notification policy. Valid values:', + 'enumValueTitles' => ['ALL' => 'Send notifications on both success and failure.', 'SUCCESS' => 'Send notifications on success.', 'NONE' => 'Do not send notifications.', 'FAILURE' => 'Send notifications on failure.'], 'type' => 'string', 'required' => false, - 'example' => 'test', + 'example' => 'NONE', + 'title' => '', ], ], [ - 'name' => 'maxResults', + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The alert group ID.', 'type' => 'string', 'required' => false, 'example' => 'ag-v7n2gp3vv3j****', 'title' => ''], + ], + [ + 'name' => 'workflowInstancePriority', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The workflow instance priority.', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], + 'type' => 'string', 'required' => false, - 'example' => '10', + 'example' => 'MEDIUM', + 'title' => '', ], ], [ - 'name' => 'workspaceId', + 'name' => 'resourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'wg-acfmv4opbs****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'taskRelationJsonValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'taskDefinitionJsonValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'nextToken' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '123abc***', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9E3A7161-EB7B-172B-8D18-FFB06BA38***'], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'project_name', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'projectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'p-3q9jo749ne5****', - ], - ], + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'workflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => 'w-acfmv4opbs****', 'title' => ''], ], - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'totalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'Create a workflow', + 'changeSet' => [ + ['createdAt' => '2024-09-06T09:45:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-05T13:24:25.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emrstudio:CreateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], - 'ListWorkflowDirectories' => [ - 'summary' => '查询工作流目录列表', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/directories', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteWorkflow' => [ + 'summary' => 'Deletes a workflow.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -341,79 +271,89 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '236078', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '219539', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'title' => '项目 ID。'."\n", - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'workspaceId', - 'in' => 'query', + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => true, 'example' => 'w-3q9jo749ne5****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '工作空间 ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '请求的分页 token。', - 'description' => '', - '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' => 'Delete a workflow', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emrstudio:DeleteWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeId' => [ + 'summary' => 'Based on the encoding ID provided by the User, automatically detect the ID Type and return associated information such as the workspace ID, project ID, pipeline ID, pipeline instance ID, Job ID, task instance ID, one-time task ID, and one-time task instance 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' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wd-y98v7non5dx****', - ], + 'schema' => ['title' => '', 'description' => 'Workspace ID ', 'type' => 'string', 'required' => true, 'example' => '111234'], ], ], 'responses' => [ @@ -423,89 +363,57 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'title' => '下一次请求的分页 token。', - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'totalCount' => [ - 'title' => '记录总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + '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' => '', - 'type' => 'string', - 'example' => 'w-lxyy60mpgpg****', - ], - 'parentDirectoryId' => [ - 'title' => '父目录ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'wd-y98v7non5dx****', - ], - 'directoryId' => [ - 'title' => '目录ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'wd-y98v7non5dx****', - ], - 'projectId' => [ - 'title' => '项目ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'p-v7n28j0m4ol****', - ], - ], + 'title' => '', + 'description' => 'return value', + 'type' => 'object', + 'properties' => [ + 'inputId' => ['title' => '', 'description' => 'input ID', 'type' => 'string', 'example' => 'p-123****'], + 'inputIdType' => ['title' => '', 'description' => 'input ID Type', 'type' => 'string', 'example' => 'PROJECT'], + 'workspaceId' => ['title' => '', 'description' => 'Workspace ID ', 'type' => 'string', 'example' => 'workspace-123****'], + 'projectId' => ['title' => '', 'description' => 'project ID', 'type' => 'string', 'example' => 'p-123****'], + 'workflowId' => ['title' => '', 'description' => 'pipeline ID', 'type' => 'string', 'example' => 'w-123****'], + 'workflowInstanceId' => ['title' => '', 'description' => 'pipeline instance ID', 'type' => 'string', 'example' => 'wi-123****'], + 'taskId' => ['title' => '', 'description' => 'Job ID ', 'type' => 'string', 'example' => 't-123****'], + 'taskInstanceId' => ['title' => '', 'description' => 'task instance ID', 'type' => 'string', 'example' => 'ti-123****'], + 'manualTaskId' => ['title' => '', 'description' => 'one-time task ID', 'type' => 'string', 'example' => 'mt-123****'], + 'manualTaskInstanceId' => ['title' => '', 'description' => 'One-time task instance ID ', 'type' => 'string', 'example' => 'mti-123****'], ], - ], - 'maxResults' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '', - 'type' => 'string', - 'example' => '10', + 'example' => 'p-123****', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1\\",\\n \\"totalCount\\": 10,\\n \\"data\\": [\\n {\\n \\"name\\": \\"目录名称。\\",\\n \\"workflowId\\": \\"w-lxyy60mpgpg****\\",\\n \\"parentDirectoryId\\": \\"wd-y98v7non5dx****\\",\\n \\"directoryId\\": \\"wd-y98v7non5dx****\\",\\n \\"projectId\\": \\"p-v7n28j0m4ol****\\"\\n }\\n ],\\n \\"maxResults\\": \\"10\\"\\n}","type":"json"}]', - ], - 'RunWorkflow' => [ - 'summary' => '运行工作流', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/run-workflow', - 'methods' => [ - 'post', + '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' => 'Description of ID-related information ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeManualTask' => [ + 'summary' => 'Retrieves the details of a manual task.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks/{manualTaskId}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -513,396 +421,481 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '219779', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '221510', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'workflowId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-3q9jo749ne5****', - ], + 'name' => 'manualTaskId', + 'in' => 'path', + 'schema' => ['description' => 'The manual task ID.', 'type' => 'string', 'required' => true, 'example' => 'mt-3q9jo749ne5****', 'title' => ''], ], - [ - 'name' => 'resourceGroupId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'wg-acfmv4opbs****', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'ManualTaskId' => ['description' => 'The manual task ID.', 'type' => 'string', 'example' => 'mt-3q9jo749ne5****', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'ManualTaskName' => ['description' => 'The manual task name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'p-3q9jo749ne5****', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + 'TaskParams' => ['description' => 'The task parameters.', '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" + .'}', 'title' => ''], + 'ResourceIds' => ['description' => 'The list of resource IDs.', 'type' => 'string', 'example' => 'r-oy98v7n43el****', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'ParentDirectoryId' => ['description' => 'The folder ID.', 'type' => 'string', 'example' => 'mtd-oy98v7n43el****', 'title' => ''], + ], + 'example' => '', ], ], - [ - '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' => 'Retrieve manual task details', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'START_PROCESS', ], ], + ], + ], + 'DescribeManualTaskInstance' => [ + 'summary' => 'Retrieves the details of a manual node instance.', + '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' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ - 'name' => 'alertGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ag-n72kong0832****', - ], + 'name' => 'manualTaskInstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The manual node instance ID.', 'type' => 'string', 'required' => true, 'example' => 'mti-0k5vype05xm****', 'title' => ''], ], [ - 'name' => 'workflowInstancePriority', - 'in' => 'query', + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'ManualTaskInstanceId' => ['description' => 'The manual node instance ID.', 'type' => 'string', 'example' => 'mti-0k5vype05xm****', 'title' => ''], + 'ManualTaskInstanceName' => ['description' => 'The name of the manual node instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TaskType' => ['description' => 'The type of the node.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'SubmitTime' => ['description' => 'The submit time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'ExternalAppId' => ['description' => 'The external application ID.', 'type' => 'string', 'example' => 'application_123_***', 'title' => ''], + 'TaskParams' => ['description' => 'The node parameters.', '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" + .'}', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'wg-123abc***', 'title' => ''], + 'EmrClusterId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'c-b933c5aac7f7***', 'title' => ''], ], - 'example' => 'MEDIUM', + 'example' => '', ], ], - [ - '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' => 'Get manual node instance details', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeProject' => [ + 'summary' => 'Retrieves the details of a project.', + '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' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '1234'], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF_MODE' => '', - 'ALL_DEPENDENT' => '', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B897B94B-6754-5D09-AB8C-2E8186CCADC0'], + 'projectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'p-3q9jo749ne5****', 'title' => ''], + 'name' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'test_project_name'], + 'description' => ['title' => '', 'description' => 'The project description.', 'type' => 'string', 'required' => true, 'example' => 'this is a project description'], ], - 'example' => 'OFF_MODE', + 'example' => '', ], ], - [ - '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' => 'Get project details', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'RUN_MODE_PARALLEL', ], ], + ], + ], + 'DescribeTask' => [ + 'summary' => 'Retrieves the details of a node.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}/tasks/{taskId}', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221586', + 'abilityTreeNodes' => ['FEATUREemapreduce61FDX5'], + ], + 'parameters' => [ [ - 'name' => 'expectedParallelismNumber', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ - 'name' => 'scheduleTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-01 00:00:00,2024-01-02 00:00:00', - ], + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => true, 'example' => 'w-3q9jo749ne5****', 'title' => ''], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], + ], + [ + 'name' => 'taskId', + 'in' => 'path', + 'schema' => ['description' => 'The node ID.', 'type' => 'string', 'required' => true, 'example' => 't-3q9jo749ne5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'TaskId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => 't-3q9jo749ne5****', 'title' => ''], + 'TaskName' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'Version' => ['description' => 'The version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'p-3q9jo749ne5****', 'title' => ''], + 'TaskType' => ['description' => 'The node type.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + 'TaskParams' => ['description' => 'The node parameters.', '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" + .'}', 'title' => ''], + 'Flag' => [ + 'description' => 'The run flag.', + 'enumValueTitles' => ['NO' => 'NO', 'YES' => 'YES'], 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', + 'example' => 'YES', + 'title' => '', ], - 'success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'TaskPriority' => [ + 'description' => 'The node priority.', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], + 'type' => 'string', + 'example' => 'MEDIUM', + 'title' => '', ], + 'FailRetryTimes' => ['description' => 'The number of retries upon failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'FailRetryInterval' => ['description' => 'The retry interval upon failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TimeoutFlag' => [ + 'description' => 'The timeout alert flag.', + 'enumValueTitles' => ['CLOSE' => 'CLOSE', 'OPEN' => 'OPEN'], + 'type' => 'string', + 'example' => 'CLOSE', + 'title' => '', + ], + 'TimeoutNotifyStrategy' => [ + 'description' => 'The timeout policy. Valid values:'."\n" + .'- FAILED: timeout and failure.'."\n" + .'- WARNFAILED: timeout alert and failure.'."\n" + .'- WARN: timeout alert.', + 'enumValueTitles' => ['FAILED' => 'Timeout and failure.', 'WARNFAILED' => 'Timeout alert and failure.', 'WARN' => 'Timeout alert.'], + 'type' => 'string', + 'example' => 'WARN', + 'title' => '', + ], + 'Timeout' => ['description' => 'The timeout duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DelayTime' => ['description' => 'The delayed execution time.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResourceIds' => ['description' => 'The list of resource IDs.', 'type' => 'string', 'example' => 'r-oy98v7n43el****', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Retrieve node details', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', ], - 'ListWorkflows' => [ - 'summary' => '获取工作流列表', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeTaskInstance' => [ + 'summary' => 'Retrieves the details of a task instance.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], - ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'workflowInstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'required' => true, 'example' => 'wi-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'searchVal', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'taskInstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The task instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ti-3q9jo749ne5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workflowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w-3q9jo749ne5****', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'workflow_name', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'workflow description', - ], - 'createTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], - 'updateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], - 'parentDirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wd-3q9jo749ne5****', - ], - ], - ], - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123abc****', - ], - 'totalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'TaskInstanceId' => ['description' => 'The task instance ID.', 'type' => 'string', 'example' => 'ti-3q9jo749ne5****', 'title' => ''], + 'TaskInstanceName' => ['description' => 'The task instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-3q9jo749ne5****', 'title' => ''], + 'TaskVersion' => ['description' => 'The task version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'example' => 'wi-3q9jo749ne5****', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'SubmitTime' => ['description' => 'The submit time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'RetryTimes' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExternalAppId' => ['description' => 'The external application ID.', 'type' => 'string', 'example' => 'application_123_***', 'title' => ''], + 'TaskParams' => ['description' => 'The task parameters.', '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" + .'}', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'wg-123abc***', 'title' => ''], + 'EmrClusterId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'c-b933c5aac7f7***', 'title' => ''], + 'DryRun' => ['description' => 'The dry-run identifier.', 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Retrieve task instance details', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], 'DescribeWorkflow' => [ - 'summary' => '获取工作流详情', + 'summary' => 'Get workflow details.', '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' => [ @@ -910,526 +903,400 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '221441', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-n72kong0832****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-n72kong0832****', 'title' => ''], ], [ 'name' => 'workflowId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-n72kong0832****', - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => true, 'example' => 'w-n72kong0832****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '611AD6E6-BFE3-5897-AA12-569F79DBAF9B', - ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '611AD6E6-BFE3-5897-AA12-569F79DBAF9B', 'title' => ''], 'workflow' => [ - 'description' => '', + 'description' => 'The workflow information.', 'type' => 'object', 'properties' => [ - 'workflowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w-n72kong0832****', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'workflowParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => ' [{"prop":"key1","value":"value1"}]', - ], - 'parentDirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wd-n72kong0832****', - ], - 'timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'workflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => 'w-n72kong0832****', 'title' => ''], + 'name' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'description' => ['description' => 'The workflow description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'workflowParams' => ['description' => 'The workflow parameters.', 'type' => 'string', 'example' => ' [{"prop":"key1","value":"value1"}]', 'title' => ''], + 'parentDirectoryId' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => 'wd-n72kong0832****', 'title' => ''], + 'timeout' => ['description' => 'The timeout period. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'executionType' => [ - 'description' => '', + 'description' => 'The execution strategy.', + 'enumValueTitles' => ['SERIAL_WAIT' => 'Serial wait', 'PARALLEL' => 'Parallel'], 'type' => 'string', - 'enumValueTitles' => [ - 'SERIAL_WAIT' => '', - 'PARALLEL' => '', - ], 'example' => 'PARALLEL', + 'title' => '', ], - 'createTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], - 'updateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'tasks' => [ - 'description' => '', + 'description' => 'The task list.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The task object.', 'type' => 'object', 'properties' => [ - 'taskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 't-n72kong0832****', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'task_name', - ], - 'version' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'task description', - ], + 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-n72kong0832****', 'title' => ''], + 'name' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'task_name', 'title' => ''], + 'version' => ['description' => 'The task version.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'description' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'task description', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'taskRelations' => [ - 'description' => '', + 'description' => 'The task dependency list.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The task dependency.', 'type' => 'object', 'properties' => [ - 'preTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 't-n72kong0832****', - ], - 'postTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 't-n72kong0832****', - ], + 'preTaskId' => ['description' => 'The upstream task ID. A value of 0 indicates that the task has no upstream node.', 'type' => 'string', 'example' => 't-n72kong0832****', 'title' => ''], + 'postTaskId' => ['description' => 'The downstream task ID.', 'type' => 'string', 'example' => 't-n72kong0832****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'schedule' => [ - 'description' => '', + 'description' => 'The scheduling information.', 'type' => 'object', 'properties' => [ 'scheduleState' => [ - 'description' => '', + 'description' => 'The schedule state.', + 'enumValueTitles' => ['OFFLINE' => 'Offline', 'ONLINE' => 'Online'], 'type' => 'string', - 'enumValueTitles' => [ - 'OFFLINE' => '', - 'ONLINE' => '', - ], 'example' => 'OFFLINE', + 'title' => '', ], - 'scheduleStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], - 'scheduleEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', - ], - 'cronExpr' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0 0 * * * ? *', - ], - 'timeZone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], + 'scheduleStartTime' => ['description' => 'The schedule start time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], + 'scheduleEndTime' => ['description' => 'The schedule end time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], + 'cronExpr' => ['description' => 'The cron expression for scheduling.', 'type' => 'string', 'example' => '0 0 * * * ? *', 'title' => ''], + 'timeZone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai', 'title' => ''], 'failureStrategy' => [ - 'description' => '', + 'description' => 'The failure strategy.', + 'enumValueTitles' => ['CONTINUE' => 'Continue', 'END' => 'End'], 'type' => 'string', - 'enumValueTitles' => [ - 'CONTINUE' => '', - 'END' => '', - ], 'example' => 'END', + 'title' => '', ], 'alertStrategy' => [ - 'description' => '', + 'description' => 'The alert strategy.', + 'enumValueTitles' => ['ALL' => 'Send alerts on both success and failure', 'SUCCESS' => 'Send alerts on success', 'NONE' => 'Never send alerts', 'FAILURE' => 'Send alerts on failure'], 'type' => 'string', - 'enumValueTitles' => [ - 'ALL' => '', - 'SUCCESS' => '', - 'NONE' => '', - 'FAILURE' => '', - ], 'example' => 'NONE', + 'title' => '', ], - 'alertGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ag-n72kong0832****', - ], + 'alertGroupId' => ['description' => 'The alert group ID.', 'type' => 'string', 'example' => 'ag-n72kong0832****', 'title' => ''], 'workflowInstancePriority' => [ - 'description' => '', + 'description' => 'The workflow instance priority.', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], 'type' => 'string', - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], 'example' => 'MEDIUM', + 'title' => '', ], - 'resourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wg-susqimrr649x****', - ], - 'emrClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C-15F7AB9B53F1****', - ], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'wg-susqimrr649x****', 'title' => ''], + 'emrClusterId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'C-15F7AB9B53F1****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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"}]', - ], - 'UpdateWorkflow' => [ - 'summary' => '更新工作流', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', + 'title' => 'Get Workflow Details', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeWorkflowInstance' => [ + 'summary' => 'Retrieves the details of a workflow instance.', + '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' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'workflowId', + 'name' => 'workflowInstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-n72kong0832****', - ], + 'schema' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'required' => true, 'example' => 'wf-3q9jo749ne5****', 'title' => ''], ], - [ - 'name' => 'workspaceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'workflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'example' => 'wi-3q9jo749ne5****', 'title' => ''], + 'workflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => 'w-3q9jo749ne5****', 'title' => ''], + 'workflowVersion' => ['description' => 'The workflow version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'endTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'scheduleTime' => ['description' => 'The scheduling time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'runTimes' => ['description' => 'The number of runs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'name' => ['description' => 'The workflow instance name.', 'type' => 'string', 'example' => 'workflow_instance_name', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'wg-susqimrr649x****', 'title' => ''], + 'emrClusterId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'c-047fa6bbe732****', 'title' => ''], + 'timeout' => ['description' => 'The timeout period. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'isComplementData' => ['description' => 'Indicates whether the instance is a data backfill instance.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'failureStrategy' => [ + 'description' => 'The failure strategy. Valid values:'."\n" + .'- CONTINUE: Continue.'."\n" + .'- END: End.', + 'enumValueTitles' => ['CONTINUE' => 'Continue.', 'END' => 'End.'], + 'type' => 'string', + 'example' => 'END', + 'title' => '', + ], + 'alertStrategy' => [ + 'description' => 'The notification strategy. Valid values:'."\n" + .'- ALL: Send notifications on both success and failure.'."\n" + .'- SUCCESS: Send notifications on success.'."\n" + .'- NONE: Do not send notifications.'."\n" + .'- FAILURE: Send notifications on failure.', + 'enumValueTitles' => ['ALL' => 'Send notifications on both success and failure.', 'SUCCESS' => 'Send notifications on success.', 'NONE' => 'Do not send notifications.', 'FAILURE' => 'Send notifications on failure.'], + 'type' => 'string', + 'example' => 'NONE', + 'title' => '', + ], + 'alertGroupId' => ['description' => 'The alert group ID.', 'type' => 'string', 'example' => 'ag-n72kong0832****', 'title' => ''], + 'workflowInstancePriority' => [ + 'description' => 'The workflow instance priority.', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], + 'type' => 'string', + 'example' => 'MEDIUM', + 'title' => '', + ], + 'restartTime' => ['description' => 'The restart time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + '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' => 'Get workflow instance details', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetInstanceLog' => [ + 'summary' => 'Retrieve the instance log ', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/instances/{instanceId}/log', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'taskRelationJson', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', - ], + 'AK' => [], ], + ], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236258', + 'abilityTreeNodes' => ['FEATUREemapreduceVHPGXM', 'FEATUREemapreduce3835LZ'], + ], + 'parameters' => [ [ - 'name' => 'taskDefinitionJson', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => ' [{"taskId":"t1","name":"t1","taskParams":{"rawScript":"echo 1"},"taskType":"SHELL"}]', - ], + 'schema' => ['title' => '', 'description' => 'Workspace ID ', 'type' => 'string', 'required' => true, 'example' => 'w-111'], ], [ - 'name' => 'description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Project ID ', 'type' => 'string', 'required' => true, 'example' => 'p-12***'], ], [ - 'name' => 'workflowParams', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{"prop":"key1","value":"value1"}]', - ], + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'Instance ID ', 'type' => 'string', 'required' => true, 'example' => 'ti-888***'], ], [ - 'name' => 'parentDirectoryId', + 'name' => 'skipLineNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wd-n72kong0832****', - ], + 'schema' => ['title' => '', 'description' => 'Number of lines to skip ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'timeout', + 'name' => 'limit', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'Number of entries per query ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], - [ - 'name' => 'executionType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SERIAL_WAIT' => '', - 'PARALLEL' => '', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890'], + 'data' => [ + 'title' => '', + 'description' => 'Return value ', + 'type' => 'object', + 'properties' => [ + 'lineNum' => ['title' => '', 'description' => 'Total number of lines ', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'message' => ['title' => '', 'description' => 'Log ', 'type' => 'string', 'example' => '"logs"'], + ], + 'example' => 'p-123****', + ], ], - 'example' => 'PARALLEL', + 'example' => '', ], ], - [ - 'name' => 'scheduleState', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFFLINE' => '', - 'ONLINE' => '', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1234567890\\",\\n \\"data\\": {\\n \\"lineNum\\": 1,\\n \\"message\\": \\"\\\\\\"logs\\\\\\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve task instance log ', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:GetInstanceLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'OFFLINE', - ], - ], - [ - 'name' => 'scheduleStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-01 00:00:00', - ], - ], - [ - 'name' => 'scheduleEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-01-01 00:00:00', - ], - ], - [ - 'name' => 'cronExpr', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0 * * * ? *', - ], - ], - [ - 'name' => 'timeZone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Asia/Shanghai', ], ], + ], + ], + 'ListAlertGroups' => [ + 'summary' => 'Query the alert group list. ', + 'path' => '/dolphinscheduler/v3/alert-groups', + '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' => 'list', + 'abilityTreeCode' => '235695', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], + ], + 'parameters' => [ [ - 'name' => 'alertStrategy', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ALL' => '', - 'SUCCESS' => '', - 'NONE' => '', - 'FAILURE' => '', - ], - 'example' => 'NONE', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'w-lxyy60mpgpg****'], ], [ - 'name' => 'alertGroupId', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ag-n72kong0832****', - ], + 'schema' => ['title' => '', 'description' => 'The paging token for the request.', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'workflowInstancePriority', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], - 'example' => 'MEDIUM', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'resourceGroupId', + 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wg-acfmv4opbs****', - ], + 'schema' => ['title' => '', 'description' => 'The query keyword.', 'type' => 'string', 'required' => false, 'example' => 'name'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'taskRelationJsonValue' => [ - 'type' => 'string', - ], - 'taskDefinitionJsonValue' => [ - 'type' => 'string', - ], - ], - ], + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'p-3q9jo749ne5****'], ], ], 'responses' => [ @@ -1439,35 +1306,58 @@ '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 of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['title' => '', 'description' => 'The paging token for the request.', 'type' => 'string', 'example' => '0'], + 'totalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'data' => [ + 'title' => '', + 'description' => 'Return Result. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'groupName' => ['title' => '', 'description' => 'Alert group name. ', 'type' => 'string', 'example' => 'name'], + 'alertInstanceIds' => ['title' => '', 'description' => 'Alert instance IDs. ', 'type' => 'string', 'example' => '50'], + 'description' => ['title' => '', 'description' => 'Description. ', 'type' => 'string', 'example' => 'description'], + 'createTime' => ['title' => '', 'description' => 'Creation Time. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1726834240000'], + 'updateTime' => ['title' => '', 'description' => 'Update Time. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1726834240000'], + 'alertGroupId' => ['title' => '', 'description' => 'Alert group ID. ', 'type' => 'string', 'example' => 'ag-8mklwpevk74****'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], + 'example' => '', ], ], ], - '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' => 'Retrieve the Alerting group List', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListAlertGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', ], - 'CreateWorkflow' => [ - 'summary' => '创建工作流', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListManualTaskInstances' => [ + 'summary' => 'Retrieves a list of manual task instances.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1475,1022 +1365,654 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '220061', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '221584', + 'abilityTreeNodes' => ['FEATUREemapreduce3835LZ'], ], 'parameters' => [ [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-n72kong0832****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The search value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'taskRelationJson', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', - ], - ], - [ - 'name' => 'taskDefinitionJson', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => ' [{"taskId":"t1","name":"t1","taskParams":{"rawScript":"echo 1"},"taskType":"SHELL"}]', - ], + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => '123abc***', 'title' => ''], ], [ - 'name' => 'description', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'workflowParams', + 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => ' [{"prop":"key1","value":"value1"}]', - ], + 'schema' => ['description' => 'The status.', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS', 'title' => ''], ], [ - 'name' => 'parentDirectoryId', + 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wd-v7n2gp3vv3j****', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00', 'title' => ''], ], [ - 'name' => 'timeout', + 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00', 'title' => ''], ], - [ - 'name' => 'executionType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SERIAL_WAIT' => '', - 'PARALLEL' => '', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '123abc***', 'title' => ''], + 'totalSize' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'data' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The manual task instance.', + 'type' => 'object', + 'properties' => [ + 'ManualTaskInstanceId' => ['description' => 'The manual task instance ID.', 'type' => 'string', 'example' => 'mti-3q9jo749ne5****', 'title' => ''], + 'ManualTaskInstanceName' => ['description' => 'The manual task instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'SubmitTime' => ['description' => 'The submit time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'ExternalAppId' => ['description' => 'The external application ID.', 'type' => 'string', 'example' => 'application_123_***', 'title' => ''], + 'TaskParams' => ['description' => 'The task parameters.', '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" + .'}', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'wg-3q9jo749ne5****', 'title' => ''], + 'EmrClusterId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'c-b933c5aac7f7***', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'PARALLEL', + 'example' => '', ], ], - [ - 'name' => 'scheduleState', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFFLINE' => '', - 'ONLINE' => '', + ], + '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' => 'Retrieve manual task instances', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], - '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', ], ], + ], + ], + 'ListManualTasks' => [ + 'summary' => 'Retrieves a list of manual tasks.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'cronExpr', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0 * * * ? *', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '221515', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], + ], + 'parameters' => [ [ - 'name' => 'timeZone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Asia/Shanghai', - ], + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'failureStrategy', + 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CONTINUE' => '', - 'END' => '', - ], - 'example' => 'END', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ - 'name' => 'alertStrategy', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ALL' => '', - 'SUCCESS' => '', - 'NONE' => '', - 'FAILURE' => '', - ], - 'example' => 'NONE', - ], + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => '123abc***', 'title' => ''], ], [ - 'name' => 'alertGroupId', + 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ag-v7n2gp3vv3j****', - ], + 'schema' => ['description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'workflowInstancePriority', + 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], - 'example' => 'MEDIUM', - ], + 'schema' => ['description' => 'The search value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'resourceGroupId', + 'name' => 'taskType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wg-acfmv4opbs****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'taskRelationJsonValue' => [ - 'type' => 'string', - ], - 'taskDefinitionJsonValue' => [ - 'type' => 'string', - ], - ], - ], + 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => false, 'example' => 'SHELL', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '123abc***', 'title' => ''], + 'totalSize' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workflowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w-acfmv4opbs****', + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The manual task.', + 'type' => 'object', + 'properties' => [ + 'ManualTaskId' => ['description' => 'The manual task ID.', 'type' => 'string', 'example' => 'mt-3q9jo749ne5****', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'ManualTaskName' => ['description' => 'The manual task name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'p-3q9jo749ne5****', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + 'TaskParams' => ['description' => 'The task parameters.', '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" + .'}', 'title' => ''], + 'ResourceIds' => ['description' => 'The list of resource IDs.', 'type' => 'string', 'example' => 'r-oy98v7n43el****', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'ParentDirectoryId' => ['description' => 'The folder ID.', 'type' => 'string', 'example' => 'mtd-oy98v7n43el****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'Retrieve manual task list', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9E3A7161-EB7B-172B-8D18-FFB06BA38***\\",\\n \\"success\\": true,\\n \\"data\\": {\\n \\"workflowId\\": \\"w-acfmv4opbs****\\"\\n }\\n}","type":"json"}]', ], - 'DeleteWorkflow' => [ - 'summary' => '删除工作流', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'ListProjects' => [ + 'summary' => 'Retrieves a list of projects.', + 'path' => '/dolphinscheduler/v3/projects', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '219539', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221489', + 'abilityTreeNodes' => ['FEATUREemapreduceBYNX2K'], ], 'parameters' => [ [ - 'name' => 'workspaceId', + 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => '123abc***', 'title' => ''], ], [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => ['description' => 'The search value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'workflowId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-3q9jo749ne5****', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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', + 'nextToken' => ['title' => '', 'description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '123abc***'], + 'data' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The projects.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'project_name', 'title' => ''], + 'description' => ['description' => 'The project description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'projectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'p-3q9jo749ne5****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], + 'totalSize' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Retrieve project list', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', ], - 'ListWorkflowInstances' => [ - 'summary' => '获取工作流实例列表', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflowInstances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListResourceGroups' => [ + 'summary' => 'Queries a list of schedule resource groups.', + 'path' => '/dolphinscheduler/v3/resourcegroups', + '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' => '236258', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'w-lxyy60mpgpg****'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['title' => '', 'description' => 'The pagination token that marks the current reading position.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], - ], - [ - 'name' => 'endTime', + 'name' => 'resourceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], + 'schema' => ['title' => '', 'description' => 'The name of the schedule resource group.', 'type' => 'string', 'example' => 'name', 'required' => false], ], [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', - ], - ], - [ - 'name' => 'workflowId', + 'name' => 'resourceGroupType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-3q9jo749ne5****', - ], + 'schema' => ['title' => '', 'description' => 'The type of the schedule resource group.'."\n" + ."\n" + .'Valid values:'."\n" + .'- CLUSTER_RESOURCE_GROUP: cluster resource group.'."\n" + .'- CLUSTER_TEMPLATE_RESOURCE_GROUP: cluster template resource group.'."\n" + .'- DEFAULT_RESOURCE_GROUP: default resource group.', 'type' => 'string', 'example' => 'CLUSTER_RESOURCE_GROUP', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'nextToken' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '1。', 'title' => ''], + 'totalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'workflowInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wi-3q9jo749ne5****', - ], - 'workflowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w-3q9jo749ne5****', - ], - 'workflowVersion' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'workflow_instance_name', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'startTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', + 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the schedule resource group.', 'type' => 'string', 'example' => 'rg-acfm4ewqrznxxxx'], + 'createTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-09-26T02:10:04Z'], + 'resourceGroupName' => ['title' => '', 'description' => 'The name of the schedule resource group.', 'type' => 'string', 'example' => '离线资源组。'], + 'paymentType' => ['title' => '', 'description' => 'The billing type.', 'type' => 'string', 'example' => 'postpaid'], + 'resourceGroupType' => ['title' => '', 'description' => 'The type of the schedule resource group.', 'type' => 'string', 'example' => 'CLUSTER_RESOURCE_GROUP。'], + 'nodeType' => ['description' => 'The node specifications. Valid values:'."\n" + .'- **EMR_W1_SMALL**: small specifications.'."\n" + .'- **EMR_W1_MEDIUM**: medium specifications.'."\n" + .'- **EMR_W1_LARGE**: large specifications.', 'type' => 'string', 'title' => '', 'example' => 'EMR_W1_SMALL。'], + 'nodeMinCount' => ['title' => '', 'description' => 'The minimum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1。'], + 'nodeMaxCount' => ['title' => '', 'description' => 'The maximum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2。'], + 'associatedWorkspaces' => [ + 'title' => '', + 'description' => 'The list of associated workspaces.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'workspaceId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => '1200827。'], + 'workspaceName' => ['title' => '', 'description' => 'The workspace name.', 'type' => 'string', 'example' => '数据开发1组。'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'endTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', + 'associatedClusterTemplates' => [ + 'title' => '', + 'description' => 'The list of associated cluster templates.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'templateId' => ['title' => '', 'description' => 'The cluster template ID.', 'type' => 'string', 'example' => '78723f0dc36。'], + 'templateName' => ['title' => '', 'description' => 'The cluster template name.', 'type' => 'string', 'example' => '模版1。'], + 'clusterType' => ['title' => '', 'description' => 'The type.', 'type' => 'string', 'example' => '集群类型，取值：'."\n" + .'- **DATALAKE**。'."\n" + .'- **CUSTOM**。'."\n" + .'- **HADOOP**。'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'scheduleTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-01-01 00:00:00', + 'associatedClusters' => [ + 'title' => '', + 'description' => 'The list of associated clusters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'example' => 'c-3cd8ba94b36cxxxx'], + 'clusterName' => ['title' => '', 'description' => 'The cluster name.', 'type' => 'string', 'example' => '离线集群。'], + 'clusterType' => ['title' => '', 'description' => 'The type.', 'type' => 'string', 'example' => '集群类型，取值：'."\n" + .'- **DATALAKE**。'."\n" + .'- **CUSTOM**。'."\n" + .'- **HADOOP**。'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10。'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"workflowInstanceId\\": \\"wi-3q9jo749ne5****\\",\\n \\"workflowId\\": \\"w-3q9jo749ne5****\\",\\n \\"workflowVersion\\": 1,\\n \\"name\\": \\"workflow_instance_name\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"startTime\\": \\"2024-01-01 00:00:00\\",\\n \\"endTime\\": \\"2024-01-01 00:00:00\\",\\n \\"scheduleTime\\": \\"2024-01-01 00:00:00\\"\\n }\\n ],\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\"\\n}","type":"json"}]', - ], - 'DescribeWorkflowInstance' => [ - 'summary' => '获取工作流实例详情', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflowInstances/{workflowInstanceId}', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'https', + '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' => 'List schedule resource groups', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListTaskInstances' => [ + 'summary' => 'Get the list of task instances.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/taskInstances', + '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' => '221613', + 'abilityTreeNodes' => ['FEATUREemapreduce5Q1MGZ'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ 'name' => 'workflowInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'wf-3q9jo749ne5****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'workflowInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wi-3q9jo749ne5****', - ], - 'workflowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w-3q9jo749ne5****', - ], - 'workflowVersion' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'startTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'endTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'scheduleTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'runTimes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'workflow_instance_name', - ], - 'resourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wg-susqimrr649x****', - ], - 'emrClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c-047fa6bbe732****', - ], - 'timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'isComplementData' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'requestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'failureStrategy' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'CONTINUE' => '', - 'END' => '', - ], - 'example' => 'END', - ], - 'alertStrategy' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'ALL' => '', - 'SUCCESS' => '', - 'NONE' => '', - 'FAILURE' => '', - ], - 'example' => 'NONE', - ], - 'alertGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ag-n72kong0832****', - ], - 'workflowInstancePriority' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], - 'example' => 'MEDIUM', - ], - 'restartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"workflowInstanceId\\": \\"wi-3q9jo749ne5****\\",\\n \\"workflowId\\": \\"w-3q9jo749ne5****\\",\\n \\"workflowVersion\\": 1,\\n \\"status\\": \\"SUCCESS\\",\\n \\"startTime\\": \\"2024-03-27 00:00:00\\",\\n \\"endTime\\": \\"2024-03-27 00:00:00\\",\\n \\"scheduleTime\\": \\"2024-03-27 00:00:00\\",\\n \\"runTimes\\": 1,\\n \\"name\\": \\"workflow_instance_name\\",\\n \\"resourceGroupId\\": \\"wg-susqimrr649x****\\",\\n \\"emrClusterId\\": \\"c-047fa6bbe732****\\",\\n \\"timeout\\": 0,\\n \\"isComplementData\\": false,\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"failureStrategy\\": \\"END\\",\\n \\"alertStrategy\\": \\"NONE\\",\\n \\"alertGroupId\\": \\"ag-n72kong0832****\\",\\n \\"workflowInstancePriority\\": \\"MEDIUM\\",\\n \\"restartTime\\": \\"2024-03-27 00:00:00\\"\\n}","type":"json"}]', - ], - 'OperateWorkflowInstance' => [ - 'summary' => '操作工作流实例', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/execute', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '235673', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce265SSG', - ], - ], - 'parameters' => [ - [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'in' => 'query', + 'schema' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'required' => false, 'example' => 'wi-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'workflowInstanceId' => [ - 'title' => '工作流实例ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'wi-l9o479p8rrx****', - ], - 'execType' => [ - 'title' => '执行类型。'."\n" - .'取值范围：'."\n" - .'- REPEAT_RUNNING：重复运行工作流。'."\n" - .'- RECOVER_SUSPENDED_PROCESS： 恢复暂停工作流。'."\n" - .'- START_FAILURE_TASK_PROCESS：从失败任务开始运行工作流。'."\n" - .'- STOP：停止工作流。'."\n" - .'- PAUSE： 暂停工作流。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PAUSE', - ], - ], - 'required' => false, - ], + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => ['description' => 'The search value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'workspaceId', + 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'title' => '工作空间 ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-lxyy60mpgpg****', - ], + 'schema' => ['description' => 'The status.', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'success' => [ - 'title' => '是否成功。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', - ], - 'DescribeManualTask' => [ - 'summary' => '获取手动任务定义', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks/{manualTaskId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '221510', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'workspaceId', + 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00', 'title' => ''], ], [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => '123abc***', 'title' => ''], ], [ - 'name' => 'manualTaskId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mt-3q9jo749ne5****', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records to retrieve at a time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'ManualTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mt-3q9jo749ne5****', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'ManualTaskName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'p-3q9jo749ne5****', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'ResourceIds' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'r-oy98v7n43el****', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'ParentDirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mtd-oy98v7n43el****', + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9E3A7161-EB7B-172B-8D18-FFB06BA38***'], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '123abc***', 'title' => ''], + 'totalSize' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'data' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The task instance.', + 'type' => 'object', + 'properties' => [ + 'TaskInstanceId' => ['description' => 'The task instance ID.', 'type' => 'string', 'example' => 'ti-3q9jo749ne5****', 'title' => ''], + 'TaskInstanceName' => ['description' => 'The task instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DryRun' => ['description' => 'The dry run flag.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'EmrClusterId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'c-b933c5aac7f7***', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'wg-3q9jo749ne5****', 'title' => ''], + 'TaskParams' => ['description' => 'The task parameters.', '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" + .'}', 'title' => ''], + 'ExternalAppId' => ['description' => 'The external application ID.', 'type' => 'string', 'example' => 'application_123_***', 'title' => ''], + 'RetryTimes' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'SubmitTime' => ['description' => 'The submit time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'example' => 'wi-3q9jo749ne5****', 'title' => ''], + 'TaskVersion' => ['description' => 'The task version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-3q9jo749ne5****', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'Get the list of task instances', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], - 'ListManualTasks' => [ - 'summary' => '查询手动任务定义列表', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListTasks' => [ + 'summary' => 'Retrieves a list of tasks.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/tasks', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2499,337 +2021,154 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '221515', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'abilityTreeCode' => '221598', + 'abilityTreeNodes' => ['FEATUREemapreduce61FDX5'], ], 'parameters' => [ [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], - ], - [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], + ], + [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => '123abc***', 'title' => ''], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'searchVal', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The search value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'taskType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SHELL', - ], + 'schema' => ['description' => 'The task type.', 'type' => 'string', 'required' => false, 'example' => 'SHELL', 'title' => ''], + ], + [ + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => false, 'example' => 'w-n72kong0832****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '123abc***', 'title' => ''], + 'totalSize' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The task.', 'type' => 'object', 'properties' => [ - 'ManualTaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mt-3q9jo749ne5****', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'ManualTaskName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'p-3q9jo749ne5****', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'ResourceIds' => [ - 'description' => '', + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 't-3q9jo749ne5****', 'title' => ''], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-03-27 00:00:00', 'title' => ''], + 'Version' => ['description' => 'The version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'p-3q9jo749ne5****', 'title' => ''], + 'TaskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'SHELL', 'title' => ''], + 'TaskParams' => ['description' => 'The task parameters.', '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" + .'}', 'title' => ''], + 'Flag' => ['description' => 'The run flag.', 'type' => 'string', 'example' => 'YES', 'title' => ''], + 'TaskPriority' => [ + 'description' => 'The task priority.', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], 'type' => 'string', - 'example' => 'r-oy98v7n43el****', + 'example' => 'MEDIUM', + 'title' => '', ], - 'UpdateTime' => [ - 'description' => '', + 'FailRetryTimes' => ['description' => 'The number of retries upon failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'FailRetryInterval' => ['description' => 'The retry interval upon failure.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TimeoutFlag' => [ + 'description' => 'The timeout alert flag. Valid values:'."\n" + .'- CLOSE: disabled.'."\n" + .'- OPEN: enabled.', + 'enumValueTitles' => ['CLOSE' => 'Disabled.', 'OPEN' => 'Enabled.'], 'type' => 'string', - 'example' => '2024-03-27 00:00:00', + 'example' => 'CLOSE', + 'title' => '', ], - 'ParentDirectoryId' => [ - 'description' => '', + 'TimeoutNotifyStrategy' => [ + 'description' => 'The timeout policy. Valid values:'."\n" + .'- FAILED: timeout failure.'."\n" + .'- WARNFAILED: timeout alert and failure.'."\n" + .'- WARN: timeout alert.', + 'enumValueTitles' => ['FAILED' => 'Timeout failure.', 'WARNFAILED' => 'Timeout alert and failure.', 'WARN' => 'Timeout alert.'], 'type' => 'string', - 'example' => 'mtd-oy98v7n43el****', + 'example' => 'WARN', + 'title' => '', ], + 'Timeout' => ['description' => 'The timeout duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DelayTime' => ['description' => 'The delayed execution time.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResourceIds' => ['description' => 'The list of resource IDs.', 'type' => 'string', 'example' => 'r-3q9jo749ne5****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"ManualTaskId\\": \\"mt-3q9jo749ne5****\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ManualTaskName\\": \\"test\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"p-3q9jo749ne5****\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"ResourceIds\\": \\"r-oy98v7n43el****\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"ParentDirectoryId\\": \\"mtd-oy98v7n43el****\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'DescribeManualTaskInstance' => [ - 'summary' => '获取手动任务实例', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances/{manualTaskInstanceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '221526', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce3835LZ', - ], - ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], - ], - [ - 'name' => 'manualTaskInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mti-0k5vype05xm****', - ], - ], - [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'ManualTaskInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mti-0k5vype05xm****', - ], - 'ManualTaskInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'SubmitTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'ExternalAppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'application_123_***', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wg-123abc***', - ], - 'EmrClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"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' => 'Retrieve task list', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], - 'ListManualTaskInstances' => [ - 'summary' => '获取手动任务实例列表', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkflowDirectories' => [ + 'summary' => 'Query the list of workflow directories.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/directories', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2838,693 +2177,318 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '221584', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce3835LZ', - ], + 'abilityTreeCode' => '236078', + 'abilityTreeNodes' => ['FEATUREemapreduceYP2JJQ'], ], 'parameters' => [ [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['title' => '', 'description' => 'Project ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****'], ], [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], - ], - [ - 'name' => 'searchVal', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['title' => '', 'description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345'], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['title' => '', 'description' => 'The pagination token for the request.', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', - ], + 'schema' => ['title' => '', 'description' => 'The maximum number of records to retrieve at a time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'startTime', + 'name' => 'parentDirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], + 'schema' => ['title' => '', 'description' => 'Parent directory ID.', 'type' => 'string', 'example' => 'wd-y98v7non5d****', 'required' => false], ], [ - 'name' => 'endTime', + 'name' => 'directoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-03-27 00:00:00', - ], + 'schema' => ['title' => '', 'description' => 'Directory ID.', 'type' => 'string', 'example' => 'wd-y98v7non5dx****', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'nextToken' => ['title' => '', 'description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '1'], + 'totalCount' => ['title' => '', 'description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'data' => [ - 'description' => '', + 'title' => '', + 'description' => 'Returned results.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ManualTaskInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mti-3q9jo749ne5****', - ], - 'ManualTaskInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'SubmitTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'ExternalAppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'application_123_***', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wg-3q9jo749ne5****', - ], - 'EmrClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], + 'name' => ['title' => '', 'description' => 'Directory name.', 'type' => 'string', 'example' => '目录名称。'], + 'workflowId' => ['title' => '', 'description' => 'Workflow ID.', 'type' => 'string', 'example' => 'w-lxyy60mpgpg****'], + 'parentDirectoryId' => ['title' => '', 'description' => 'Parent directory ID.', 'type' => 'string', 'example' => 'wd-y98v7non5dx****'], + 'directoryId' => ['title' => '', 'description' => 'Directory ID.', 'type' => 'string', 'example' => 'wd-y98v7non5dx****'], + 'projectId' => ['title' => '', 'description' => 'Project ID.', 'type' => 'string', 'example' => 'p-v7n28j0m4ol****'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'maxResults' => ['title' => '', 'description' => 'The maximum number of records to retrieve at a time.', 'type' => 'string', 'example' => '10'], ], + 'example' => '', ], ], ], - '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' => 'Get workflow directory list', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], - 'ListTasks' => [ - 'summary' => '查询任务定义列表', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/tasks', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkflowInstances' => [ + 'summary' => 'Retrieves a list of workflow instances.', + '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' => '221598', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce61FDX5', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221706', + 'abilityTreeNodes' => ['FEATUREemapreduceVHPGXM'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123abc***', - ], + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => '123abc***', 'title' => ''], ], [ 'name' => 'maxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The maximum number of records to retrieve in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'searchVal', + 'name' => 'startTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00', 'title' => ''], ], [ - 'name' => 'taskType', + 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SHELL', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2024-03-27 00:00:00', 'title' => ''], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['description' => 'The status.', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS', 'title' => ''], ], [ 'name' => 'workflowId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'w-n72kong0832****', - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => false, 'example' => 'w-3q9jo749ne5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'nextToken' => ['title' => '', 'description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '123abc***'], + 'totalSize' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'data' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The workflow instance details.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 't-3q9jo749ne5****', - ], - 'TaskName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'p-3q9jo749ne5****', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'Flag' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'YES', - ], - 'TaskPriority' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], - 'example' => 'MEDIUM', - ], - 'FailRetryTimes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'FailRetryInterval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TimeoutFlag' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'CLOSE' => '', - 'OPEN' => '', - ], - 'example' => 'CLOSE', - ], - 'TimeoutNotifyStrategy' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => '', - 'WARNFAILED' => '', - 'WARN' => '', - ], - 'example' => 'WARN', - ], - 'Timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DelayTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResourceIds' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'r-3q9jo749ne5****', - ], + 'workflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'example' => 'wi-3q9jo749ne5****', 'title' => ''], + 'workflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => 'w-3q9jo749ne5****', 'title' => ''], + 'workflowVersion' => ['description' => 'The workflow version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'name' => ['description' => 'The workflow instance name.', 'type' => 'string', 'example' => 'workflow_instance_name', 'title' => ''], + 'status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'startTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], + 'endTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], + 'scheduleTime' => ['description' => 'The scheduling time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Retrieve workflow instance list', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"123abc***\\",\\n \\"totalSize\\": 10,\\n \\"data\\": [\\n {\\n \\"TaskId\\": \\"t-3q9jo749ne5****\\",\\n \\"TaskName\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"p-3q9jo749ne5****\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"Flag\\": \\"YES\\",\\n \\"TaskPriority\\": \\"MEDIUM\\",\\n \\"FailRetryTimes\\": 0,\\n \\"FailRetryInterval\\": 1,\\n \\"TimeoutFlag\\": \\"CLOSE\\",\\n \\"TimeoutNotifyStrategy\\": \\"WARN\\",\\n \\"Timeout\\": 0,\\n \\"DelayTime\\": 0,\\n \\"ResourceIds\\": \\"r-3q9jo749ne5****\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeTask' => [ - 'summary' => '查询任务定义', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}/tasks/{taskId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkflows' => [ + 'summary' => 'Obtains a list of workflows.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '221586', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce61FDX5', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221672', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'workflowId', + 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'required' => false, 'example' => '123abc***', 'title' => ''], ], [ - 'name' => 'taskId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 't-3q9jo749ne5****', - ], + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records to retrieve at a time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'searchVal', + 'in' => 'query', + 'schema' => ['description' => 'The search value.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 't-3q9jo749ne5****', - ], - 'TaskName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'p-3q9jo749ne5****', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'Flag' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'NO' => 'NO', - 'YES' => 'YES', - ], - 'example' => 'YES', - ], - 'TaskPriority' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'LOWEST' => 'LOWEST', - 'HIGH' => 'HIGH', - 'MEDIUM' => 'MEDIUM', - 'LOW' => 'LOW', - 'HIGHEST' => 'HIGHEST', - ], - 'example' => 'MEDIUM', - ], - 'FailRetryTimes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'FailRetryInterval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TimeoutFlag' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'CLOSE' => 'CLOSE', - 'OPEN' => 'OPEN', - ], - 'example' => 'CLOSE', - ], - 'TimeoutNotifyStrategy' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => '', - 'WARNFAILED' => '', - 'WARN' => '', + 'data' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The workflow information.', + 'type' => 'object', + 'properties' => [ + 'workflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => 'w-3q9jo749ne5****', 'title' => ''], + 'name' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'workflow_name', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'workflow description', 'title' => ''], + 'createTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], + 'updateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''], + 'parentDirectoryId' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => 'wd-3q9jo749ne5****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'WARN', - ], - 'Timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DelayTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResourceIds' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'r-oy98v7n43el****', + 'title' => '', + 'example' => '', ], + 'nextToken' => ['description' => 'The pagination token for the next request.', 'type' => 'string', 'example' => '123abc****', 'title' => ''], + 'totalSize' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'List workflows', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"TaskId\\": \\"t-3q9jo749ne5****\\",\\n \\"TaskName\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"UpdateTime\\": \\"2024-03-27 00:00:00\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": \\"p-3q9jo749ne5****\\",\\n \\"TaskType\\": \\"SHELL\\",\\n \\"TaskParams\\": \\"{\\\\n \\\\\\"yarnUser\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"conditionResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"rawScript\\\\\\": \\\\\\"sleep 300\\\\\\",\\\\n \\\\\\"submitOnYarnFlag\\\\\\": false,\\\\n \\\\\\"emrClusterId\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnPriority\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"dependence\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"yarnMemory\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"localParams\\\\\\": [],\\\\n \\\\\\"switchResult\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"resourceList\\\\\\": [],\\\\n \\\\\\"yarnQueue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"yarnVCores\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"associateManualTaskFlag\\\\\\": false\\\\n}\\",\\n \\"Flag\\": \\"YES\\",\\n \\"TaskPriority\\": \\"MEDIUM\\",\\n \\"FailRetryTimes\\": 0,\\n \\"FailRetryInterval\\": 1,\\n \\"TimeoutFlag\\": \\"CLOSE\\",\\n \\"TimeoutNotifyStrategy\\": \\"WARN\\",\\n \\"Timeout\\": 10,\\n \\"DelayTime\\": 0,\\n \\"ResourceIds\\": \\"r-oy98v7n43el****\\"\\n}","type":"json"}]', ], - 'DescribeTaskInstance' => [ - 'summary' => '获取任务实例', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowInstanceId}/taskInstances/{taskInstanceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'OperateWorkflowInstance' => [ + 'summary' => 'Operates on a workflow instance.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/execute', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3532,181 +2496,80 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '221606', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5Q1MGZ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '235673', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ - 'name' => 'workspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], - ], - [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'workflowInstanceId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'wi-3q9jo749ne5****', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'workflowInstanceId' => ['title' => '', 'description' => 'The workflow instance ID.', 'type' => 'string', 'example' => 'wi-l9o479p8rrx****', 'required' => false], + 'execType' => ['title' => '', 'description' => 'The execution type. Valid values:'."\n" + .'- REPEAT_RUNNING: reruns the workflow.'."\n" + .'- RECOVER_SUSPENDED_PROCESS: resumes a paused workflow.'."\n" + .'- START_FAILURE_TASK_PROCESS: runs the workflow starting from the failed node.'."\n" + .'- STOP: stops the workflow.'."\n" + .'- PAUSE: pauses the workflow.', 'type' => 'string', 'example' => 'PAUSE', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'taskInstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ti-3q9jo749ne5****', - ], + 'name' => 'workspaceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'w-lxyy60mpgpg****', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'TaskInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ti-3q9jo749ne5****', - ], - 'TaskInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 't-3q9jo749ne5****', - ], - 'TaskVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'WorkflowInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wi-3q9jo749ne5****', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'SubmitTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'RetryTimes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExternalAppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'application_123_***', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wg-123abc***', - ], - 'EmrClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], - 'DryRun' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'success' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Operate a workflow', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:OperateWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], - 'ListTaskInstances' => [ - 'summary' => '获取任务实例列表', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/taskInstances', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RunWorkflow' => [ + 'summary' => 'Runs a workflow.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/executors/run-workflow', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3714,1015 +2577,724 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '221613', - 'abilityTreeNodes' => [ - 'FEATUREemapreduce5Q1MGZ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '219779', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123***', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'projectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-3q9jo749ne5****', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], ], [ - 'name' => 'workflowInstanceId', + 'name' => 'workflowId', + 'in' => 'query', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => true, 'example' => 'w-3q9jo749ne5****', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => true, 'example' => 'wg-acfmv4opbs****', 'title' => ''], + ], + [ + 'name' => 'execType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The execution type.', + 'enumValueTitles' => ['COMPLEMENT_DATA' => 'data backfill.', 'START_PROCESS' => 'run workflow.'], 'type' => 'string', 'required' => false, - 'example' => 'wi-3q9jo749ne5****', + 'example' => 'START_PROCESS', + 'title' => '', ], ], [ - 'name' => 'searchVal', + 'name' => 'failureStrategy', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The failure strategy.', + 'enumValueTitles' => ['CONTINUE' => 'continue.', 'END' => 'end.'], 'type' => 'string', 'required' => false, - 'example' => 'test', + 'example' => 'END', + 'title' => '', ], ], [ - 'name' => 'status', + 'name' => 'alertStrategy', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The notification strategy.', + 'enumValueTitles' => ['ALL' => 'Send notifications on both success and failure.', 'SUCCESS' => 'Send notifications on success.', 'NONE' => 'Do not send notifications.', 'FAILURE' => 'Send notifications on failure.'], 'type' => 'string', 'required' => false, - 'example' => 'SUCCESS', + 'example' => 'NONE', + 'title' => '', ], ], [ - 'name' => 'startTime', + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The alert group ID.', 'type' => 'string', 'required' => false, 'example' => 'ag-n72kong0832****', 'title' => ''], + ], + [ + 'name' => 'workflowInstancePriority', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The priority of the workflow instance.', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], 'type' => 'string', 'required' => false, - 'example' => '2024-03-27 00:00:00', + 'example' => 'MEDIUM', + 'title' => '', ], ], [ - 'name' => 'endTime', + 'name' => 'startParams', + 'in' => 'query', + 'schema' => ['description' => 'The startup parameters.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1"}', 'title' => ''], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'The dry run flag.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'complementDependentMode', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The data backfill dependency mode.', + 'enumValueTitles' => ['OFF_MODE' => 'disabled.', 'ALL_DEPENDENT' => 'enabled.'], 'type' => 'string', 'required' => false, - 'example' => '2024-03-27 00:00:00', + 'example' => 'OFF_MODE', + 'title' => '', ], ], [ - 'name' => 'nextToken', + 'name' => 'runMode', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The data backfill execution mode.', + 'enumValueTitles' => ['RUN_MODE_SERIAL' => 'sequential execution.', 'RUN_MODE_PARALLEL' => 'parallel execution.'], 'type' => 'string', 'required' => false, - 'example' => '123abc***', + 'example' => 'RUN_MODE_PARALLEL', + 'title' => '', ], ], [ - 'name' => 'maxResults', + 'name' => 'expectedParallelismNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The parallelism for data backfill. Valid values: 1 to 7.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'scheduleTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduling date range for data backfill.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 00:00:00,2024-01-02 00:00:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9E3A7161-EB7B-172B-8D18-FFB06BA38***', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123abc***', - ], - 'totalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ti-3q9jo749ne5****', - ], - 'TaskInstanceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'DryRun' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'EmrClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c-b933c5aac7f7***', - ], - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wg-3q9jo749ne5****', - ], - 'TaskParams' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{'."\n" - .' "yarnUser": "",'."\n" - .' "conditionResult": "null",'."\n" - .' "rawScript": "sleep 300",'."\n" - .' "submitOnYarnFlag": false,'."\n" - .' "emrClusterId": "",'."\n" - .' "yarnPriority": "",'."\n" - .' "dependence": "null",'."\n" - .' "yarnMemory": "",'."\n" - .' "localParams": [],'."\n" - .' "switchResult": "null",'."\n" - .' "resourceList": [],'."\n" - .' "yarnQueue": "",'."\n" - .' "yarnVCores": "",'."\n" - .' "associateManualTaskFlag": false'."\n" - .'}', - ], - 'ExternalAppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'application_123_***', - ], - 'RetryTimes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'SubmitTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-27 00:00:00', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'WorkflowInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wi-3q9jo749ne5****', - ], - 'TaskVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 't-3q9jo749ne5****', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SHELL', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"success\\": true\\n}","type":"json"}]', + 'title' => 'Run a workflow', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:RunWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], - 'ListResourceGroups' => [ - 'summary' => '查询调度资源组列表', - 'path' => '/dolphinscheduler/v3/resourcegroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateWorkflow' => [ + 'summary' => 'Updates a workflow.', + 'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236258', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '221014', + 'abilityTreeNodes' => ['FEATUREemapreduce265SSG'], ], 'parameters' => [ [ + 'name' => 'projectId', + 'in' => 'path', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'p-3q9jo749ne5****', 'title' => ''], + ], + [ + 'name' => 'workflowId', + 'in' => 'path', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => true, 'example' => 'w-n72kong0832****', 'title' => ''], + ], + [ 'name' => 'workspaceId', 'in' => 'query', - 'schema' => [ - 'title' => '工作空间 ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-lxyy60mpgpg****', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => true, 'example' => '123***', 'title' => ''], ], [ - 'name' => 'nextToken', + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'taskRelationJson', + 'in' => 'query', + 'schema' => ['description' => 'The task dependency JSON that contains the dependencies between all tasks in the workflow. preTaskId specifies the upstream task ID, and postTaskId specifies the downstream task ID. The task IDs specified here are custom IDs that cannot be 0, and each task must have a unique ID. If a task node has no upstream task, you must still add a dependency with preTaskId set to 0.', 'type' => 'string', 'required' => false, 'example' => ' [{"preTaskId":"0", "postTaskId":"t1"}]', 'title' => ''], + ], + [ + 'name' => 'taskDefinitionJson', + 'in' => 'query', + 'schema' => ['description' => 'The task definition JSON that contains the description of all tasks in the workflow.', 'type' => 'string', 'required' => false, 'example' => ' [{"taskId":"t1","name":"t1","taskParams":{"rawScript":"echo 1"},"taskType":"SHELL"}]', 'title' => ''], + ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'workflowParams', + 'in' => 'query', + 'schema' => ['description' => 'The workflow parameters.', 'type' => 'string', 'required' => false, 'example' => '[{"prop":"key1","value":"value1"}]', 'title' => ''], + ], + [ + 'name' => 'parentDirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'The folder ID.', 'type' => 'string', 'required' => false, 'example' => 'wd-n72kong0832****', 'title' => ''], + ], + [ + 'name' => 'timeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout period. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'executionType', 'in' => 'query', 'schema' => [ - 'title' => '标记当前开始读取的位置。', - 'description' => '', + 'description' => 'The execution policy. Valid values:', + 'enumValueTitles' => ['SERIAL_WAIT' => 'sequential execution with waiting.', 'PARALLEL' => 'parallel execution.'], 'type' => 'string', 'required' => false, - 'example' => '0', + 'example' => 'PARALLEL', + 'title' => '', ], ], [ - 'name' => 'maxResults', + 'name' => 'scheduleState', 'in' => 'query', 'schema' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The scheduling status. Valid values:', + 'enumValueTitles' => ['OFFLINE' => 'offline.', 'ONLINE' => 'online.'], + 'type' => 'string', 'required' => false, - 'example' => '10', + 'example' => 'OFFLINE', + 'title' => '', ], ], [ - 'name' => 'resourceGroupName', + 'name' => 'scheduleStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduling start time.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 00:00:00', 'title' => ''], + ], + [ + 'name' => 'scheduleEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduling end time.', 'type' => 'string', 'required' => false, 'example' => '2024-01-01 00:00:00', 'title' => ''], + ], + [ + 'name' => 'cronExpr', + 'in' => 'query', + 'schema' => ['description' => 'The scheduling cron expression.', 'type' => 'string', 'required' => false, 'example' => '0 0 * * * ? *', 'title' => ''], + ], + [ + 'name' => 'timeZone', + 'in' => 'query', + 'schema' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', 'title' => ''], + ], + [ + 'name' => 'failureStrategy', 'in' => 'query', 'schema' => [ - 'title' => '调度资源组名称。', - 'description' => '', + 'description' => 'The failure policy. Valid values:', + 'enumValueTitles' => ['CONTINUE' => 'continue.', 'END' => 'end.'], 'type' => 'string', 'required' => false, - 'example' => 'name', + 'example' => 'END', + 'title' => '', ], ], [ - 'name' => 'resourceGroupType', + 'name' => 'alertStrategy', 'in' => 'query', 'schema' => [ - 'title' => '调度资源组规格。'."\n" - .'取值范围：'."\n" - .'- CLUSTER_RESOURCE_GROUP：集群资源组。'."\n" - .'- CLUSTER_TEMPLATE_RESOURCE_GROUP：集群模版资源组。'."\n" - .'- DEFAULT_RESOURCE_GROUP：默认资源组。', - 'description' => '', + 'description' => 'The notification policy. Valid values:', + 'enumValueTitles' => ['ALL' => 'send notifications on both success and failure.', 'SUCCESS' => 'send notifications on success.', 'NONE' => 'do not send notifications.', 'FAILURE' => 'send notifications on failure.'], 'type' => 'string', 'required' => false, - 'example' => 'CLUSTER_RESOURCE_GROUP', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1。', - ], - 'totalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'resourceGroupId' => [ - 'title' => '调度资源组ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'rg-acfm4ewqrznxxxx', - ], - 'createTime' => [ - 'title' => '创建时间。', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-26T02:10:04Z', - ], - 'resourceGroupName' => [ - 'title' => '调度资源组名称。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'paymentType' => [ - 'title' => '付费类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'postpaid', - ], - 'resourceGroupType' => [ - 'title' => '调度资源组类型。', - 'description' => '', - 'type' => 'string', - 'example' => 'CLUSTER_RESOURCE_GROUP。', - ], - 'nodeType' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'EMR_W1_SMALL。', - ], - 'nodeMinCount' => [ - 'title' => '最小节点数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1。', - ], - 'nodeMaxCount' => [ - 'title' => '最大节点数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2。', - ], - 'associatedWorkspaces' => [ - 'title' => '关联工作空间列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'workspaceId' => [ - 'title' => '工作空间ID。', - 'description' => '', - 'type' => 'string', - 'example' => '1200827。', - ], - 'workspaceName' => [ - 'title' => '工作空间名称。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'associatedClusterTemplates' => [ - 'title' => '关联集群模版列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'templateId' => [ - 'title' => '集群模版ID。', - 'description' => '', - 'type' => 'string', - 'example' => '78723f0dc36。', - ], - 'templateName' => [ - 'title' => '集群模版名称。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'clusterType' => [ - 'title' => '类型。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'associatedClusters' => [ - 'title' => '关联集群列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'title' => '集群ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'c-3cd8ba94b36cxxxx', - ], - 'clusterName' => [ - 'title' => '集群名称。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'clusterType' => [ - 'title' => '类型。', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - ], - ], - ], - 'maxResults' => [ - 'title' => '最大数量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10。', - ], - ], + 'example' => 'NONE', + 'title' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DD6B1B2A-5837-5237-ABE4-FF0C8944****\\",\\n \\"nextToken\\": \\"1。\\",\\n \\"totalCount\\": 16,\\n \\"data\\": [\\n {\\n \\"resourceGroupId\\": \\"rg-acfm4ewqrznxxxx\\",\\n \\"createTime\\": \\"2024-09-26T02:10:04Z\\",\\n \\"resourceGroupName\\": \\"离线资源组。\\",\\n \\"paymentType\\": \\"postpaid\\",\\n \\"resourceGroupType\\": \\"CLUSTER_RESOURCE_GROUP。\\",\\n \\"nodeType\\": \\"EMR_W1_SMALL。\\",\\n \\"nodeMinCount\\": 0,\\n \\"nodeMaxCount\\": 0,\\n \\"associatedWorkspaces\\": [\\n {\\n \\"workspaceId\\": \\"1200827。\\",\\n \\"workspaceName\\": \\"数据开发1组。\\"\\n }\\n ],\\n \\"associatedClusterTemplates\\": [\\n {\\n \\"templateId\\": \\"78723f0dc36。\\",\\n \\"templateName\\": \\"模版1。\\",\\n \\"clusterType\\": \\"集群类型，取值：\\\\n- **DATALAKE**。\\\\n- **CUSTOM**。\\\\n- **HADOOP**。\\"\\n }\\n ],\\n \\"associatedClusters\\": [\\n {\\n \\"clusterId\\": \\"c-3cd8ba94b36cxxxx\\",\\n \\"clusterName\\": \\"离线集群。\\",\\n \\"clusterType\\": \\"集群类型，取值：\\\\n- **DATALAKE**。\\\\n- **CUSTOM**。\\\\n- **HADOOP**。\\"\\n }\\n ]\\n }\\n ],\\n \\"maxResults\\": 0\\n}","type":"json"}]', - ], - 'DescribeId' => [ - 'summary' => '获取id关联信息', - 'path' => '/dolphinscheduler/v3/relatedIds', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236258', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceBYNX2K', - 'FEATUREemapreduce265SSG', - 'FEATUREemapreduceVHPGXM', - 'FEATUREemapreduce61FDX5', - 'FEATUREemapreduce5Q1MGZ', - 'FEATUREemapreduceYP2JJQ', - 'FEATUREemapreduce3835LZ', + 'name' => 'alertGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The alert group ID.', 'type' => 'string', 'required' => false, 'example' => 'ag-n72kong0832****', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'id', + 'name' => 'workflowInstancePriority', 'in' => 'query', 'schema' => [ - 'title' => 'id', - 'description' => 'id', + 'description' => 'The workflow instance priority.', + 'enumValueTitles' => ['LOWEST' => 'LOWEST', 'HIGH' => 'HIGH', 'MEDIUM' => 'MEDIUM', 'LOW' => 'LOW', 'HIGHEST' => 'HIGHEST'], 'type' => 'string', - 'required' => true, - 'example' => 'p-123****', + 'required' => false, + 'example' => 'MEDIUM', + 'title' => '', ], ], [ - 'name' => 'workspaceId', + 'name' => 'resourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'wg-acfmv4opbs****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '工作空间id', + 'type' => 'object', + 'properties' => [ + 'taskRelationJsonValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'taskDefinitionJsonValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '111234', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], - 'data' => [ - 'title' => '返回值', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'inputId' => [ - 'title' => '输入id', - 'description' => '', - 'type' => 'string', - 'example' => 'p-123****', - ], - 'inputIdType' => [ - 'title' => '输入id类型', - 'description' => '', - 'type' => 'string', - 'example' => 'PROJECT', - ], - 'workspaceId' => [ - 'title' => '工作空间id', - 'description' => '', - 'type' => 'string', - 'example' => 'workspace-123****', - ], - 'projectId' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'example' => 'p-123****', - ], - 'workflowId' => [ - 'title' => '工作流id', - 'description' => '', - 'type' => 'string', - 'example' => 'w-123****', - ], - 'workflowInstanceId' => [ - 'title' => '工作流实例id', - 'description' => '', - 'type' => 'string', - 'example' => 'wi-123****', - ], - 'taskId' => [ - 'title' => '任务id', - 'description' => '', - 'type' => 'string', - 'example' => 't-123****', - ], - 'taskInstanceId' => [ - 'title' => '任务实例id', - 'description' => '', - 'type' => 'string', - 'example' => 'ti-123****', - ], - 'manualTaskId' => [ - 'title' => '手动任务id', - 'description' => '', - 'type' => 'string', - 'example' => 'mt-123****', - ], - 'manualTaskInstanceId' => [ - 'title' => '手动任务实例id', - 'description' => '', - 'type' => 'string', - 'example' => 'mti-123****', - ], - ], - 'example' => 'p-123****', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****'], + 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - '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' => 'Update a workflow', + 'changeSet' => [ + ['createdAt' => '2024-09-06T09:45:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-05T13:24:25.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emrstudio:UpdateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', ], - 'GetInstanceLog' => [ - 'summary' => '获取实例的日志', - 'path' => '/dolphinscheduler/v3/projects/{projectId}/instances/{instanceId}/log', - 'methods' => [ - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emrstudio.cn-shenzhen.aliyuncs.com', 'endpoint' => 'emrstudio.cn-shenzhen.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emrstudio.cn-beijing.aliyuncs.com', 'endpoint' => 'emrstudio.cn-beijing.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emrstudio.cn-shanghai.aliyuncs.com', 'endpoint' => 'emrstudio.cn-shanghai.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emrstudio.cn-hongkong.aliyuncs.com', 'endpoint' => 'emrstudio.cn-hongkong.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emrstudio.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'emrstudio.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emrstudio.cn-hangzhou.aliyuncs.com', 'endpoint' => 'emrstudio.cn-hangzhou.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'emrstudio.cn-chengdu.aliyuncs.com', 'endpoint' => 'emrstudio.cn-chengdu.aliyuncs.com', 'vpc' => 'emrstudio-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'This product is about to be offline and only supports the use of existing customers.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWorkflow'], + ['description' => 'Request parameters changed', 'api' => 'UpdateWorkflow'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2024-09-06T09:45:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWorkflow'], + ['description' => 'Request parameters changed', 'api' => 'UpdateWorkflow'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2024-09-05T13:24:31.000Z', + 'description' => '', + ], + ], + 'ram' => [ + 'productCode' => 'EmrStudio', + 'productName' => 'E-MapReduce', + 'ramCodes' => ['emrstudio'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DeleteWorkflow', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'emrstudio:DeleteWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListResourceGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeProject', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236258', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceVHPGXM', - 'FEATUREemapreduce3835LZ', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-111', + [ + 'apiName' => 'ListProjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'title' => '项目id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'p-12***', + ], + [ + 'apiName' => 'UpdateWorkflow', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'emrstudio:UpdateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => '实例id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ti-888***', + ], + [ + 'apiName' => 'ListWorkflows', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'skipLineNum', - 'in' => 'query', - 'schema' => [ - 'title' => '跳过的行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ListTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'limit', - 'in' => 'query', - 'schema' => [ - 'title' => '每次查询数量', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], - 'data' => [ - 'title' => '返回值', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'lineNum' => [ - 'title' => '总行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'message' => [ - 'title' => '日志', - 'description' => '', - 'type' => 'string', - 'example' => '"logs"', - ], - ], - 'example' => 'p-123****', - ], - ], + [ + 'apiName' => 'RunWorkflow', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:RunWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetInstanceLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:GetInstanceLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'CreateWorkflow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'emrstudio:CreateWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"1234567890\\",\\n \\"data\\": {\\n \\"lineNum\\": 1,\\n \\"message\\": \\"\\\\\\"logs\\\\\\"\\"\\n }\\n}","type":"json"}]', - ], - 'ListAlertGroups' => [ - 'summary' => '查询告警组列表', - 'path' => '/dolphinscheduler/v3/alert-groups', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListManualTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeWorkflow', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeWorkflowInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeManualTaskInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListWorkflowDirectories', + 'description' => '', 'operationType' => 'list', - 'abilityTreeCode' => '235695', - 'abilityTreeNodes' => [ - 'FEATUREemapreduceYP2JJQ', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'workspaceId', - 'in' => 'query', - 'schema' => [ - 'title' => '工作空间 ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w-lxyy60mpgpg****', + [ + 'apiName' => 'DescribeTaskInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeTaskInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'nextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '请求的分页 token。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', + ], + [ + 'apiName' => 'OperateWorkflowInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'emrstudio:OperateWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'maxResults', - 'in' => 'query', - 'schema' => [ - 'title' => '一次获取的最大记录数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ListManualTaskInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListManualTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'searchVal', - 'in' => 'query', - 'schema' => [ - 'title' => '查询关键字。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'name', + ], + [ + 'apiName' => 'DescribeManualTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'emrstudio:DescribeManualTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'projectId', - 'in' => 'path', - 'schema' => [ - 'title' => '项目ID。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'p-3q9jo749ne5****', + ], + [ + 'apiName' => 'ListAlertGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListAlertGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'DD6B1B2A-5837-5237-ABE4-FF0C8944****', - ], - 'nextToken' => [ - 'title' => '请求的分页 token。', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'totalCount' => [ - 'title' => '记录总数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'data' => [ - 'title' => '返回结果。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'title' => '告警组名称。', - 'description' => '', - 'type' => 'string', - 'example' => 'name', - ], - 'alertInstanceIds' => [ - 'title' => '告警实例ID。', - 'description' => '', - 'type' => 'string', - 'example' => '50', - ], - 'description' => [ - 'title' => '描述信息。', - 'description' => '', - 'type' => 'string', - 'example' => 'description', - ], - 'createTime' => [ - 'title' => '创建时间。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1726834240000', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1726834240000', - ], - 'alertGroupId' => [ - 'title' => '告警组ID。', - 'description' => '', - 'type' => 'string', - 'example' => 'ag-8mklwpevk74****', - ], - ], - ], - ], - 'maxResults' => [ - 'title' => '一次获取的最大记录数。'."\n", - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], + [ + 'apiName' => 'ListWorkflowInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListTaskInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'emrstudio:ListTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EmrStudio', 'resourceType' => 'All Resource', '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"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'emrstudio.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'emrstudio.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'emrstudio.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'emrstudio.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'emrstudio.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'emrstudio.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'emrstudio.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'emrstudio.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'emrstudio.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'emrstudio.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'emrstudio.cn-hongkong.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |