summaryrefslogtreecommitdiff
path: root/data/zh_cn/schedulerx3
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/schedulerx3
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/schedulerx3')
-rw-r--r--data/zh_cn/schedulerx3/2024-06-24/api-docs.php19305
1 files changed, 6350 insertions, 12955 deletions
diff --git a/data/zh_cn/schedulerx3/2024-06-24/api-docs.php b/data/zh_cn/schedulerx3/2024-06-24/api-docs.php
index 77ec455..2f0ebf5 100644
--- a/data/zh_cn/schedulerx3/2024-06-24/api-docs.php
+++ b/data/zh_cn/schedulerx3/2024-06-24/api-docs.php
@@ -1,160 +1,278 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'SchedulerX3',
- 'version' => '2024-06-24',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'SchedulerX3', 'version' => '2024-06-24'],
'directories' => [
[
- 'id' => 199499,
- 'title' => '集群',
+ 'children' => ['CreateCluster', 'UpdateCluster', 'DeleteCluster', 'GetCluster', 'ListClusters'],
'type' => 'directory',
- 'children' => [
- 'CreateCluster',
- 'UpdateCluster',
- 'DeleteCluster',
- 'GetCluster',
- 'ListClusters',
- ],
+ 'title' => '集群',
+ 'id' => 317302,
],
[
- 'id' => 199532,
- 'title' => '应用',
+ 'children' => ['UpdateApp', 'GetApp', 'DeleteApp', 'ListApps', 'ListAppNames', 'ListLables', 'ListExecutors'],
'type' => 'directory',
- 'children' => [
- 'CreateApp',
- 'UpdateApp',
- 'GetApp',
- 'DeleteApp',
- 'ListApps',
- 'ListAppNames',
- 'ListLables',
- 'ListExecutors',
- ],
+ 'title' => '应用',
+ 'id' => 317321,
],
[
- 'id' => 278802,
- 'title' => '执行器',
+ 'children' => ['UpdateExecutors', 'GetExecutorConfig', 'CreateExecutors'],
'type' => 'directory',
- 'children' => [
- 'UpdateExecutors',
- 'GetExecutorConfig',
- 'CreateExecutors',
- ],
+ 'title' => '执行器',
+ 'id' => 317351,
],
[
- 'id' => 199533,
- 'title' => '任务',
+ 'children' => ['SyncJobs', 'CreateJob', 'UpdateJob', 'UpdateJobScript', 'DeleteJobs', 'OperateEnableJobs', 'OperateDisableJobs', 'OperateRerunJob', 'ListJobs', 'ListJobScriptHistory', 'GetDesigateInfo'],
'type' => 'directory',
- 'children' => [
- 'SyncJobs',
- 'CreateJob',
- 'UpdateJob',
- 'UpdateJobScript',
- 'DeleteJobs',
- 'OperateEnableJobs',
- 'OperateDisableJobs',
- 'OperateRerunJob',
- 'ListJobs',
- 'ListJobScriptHistory',
- 'GetDesigateInfo',
- ],
+ 'title' => '任务',
+ 'id' => 317330,
],
[
- 'id' => 199534,
- 'title' => '任务执行',
+ 'children' => ['GetJobExecution', 'OperateStopJobExecution', 'OperateDesignateExecutors', 'OperateRetryJobExecution', 'OperateExecuteJob', 'GetJobExecutionProgress', 'GetJobExecutionThreadDump', 'ListJobExecutions'],
'type' => 'directory',
- 'children' => [
- 'GetJobExecution',
- 'OperateStopJobExecution',
- 'OperateDesignateExecutors',
- 'OperateRetryJobExecution',
- 'OperateExecuteJob',
- 'GetJobExecutionProgress',
- 'GetJobExecutionThreadDump',
- 'ListJobExecutions',
- ],
+ 'title' => '任务执行',
+ 'id' => 317342,
],
[
- 'id' => 199500,
- 'title' => '其他',
- 'type' => 'directory',
'children' => [
- 'ListK8sResource',
- 'GetLogEvent',
- 'ImportJobs',
- 'ListRegions',
- 'ListRegionZone',
- 'ListCalendarNames',
- 'ListScheduleEvent',
- 'ListAlarmEvent',
- 'ListScheduleTimes',
- 'ImportCalendar',
- 'ExportJobs',
- 'GetLog',
- 'OperateMarkSuccessWorkflowExecution',
- 'OperateSkipJobExecution',
- 'UpdateWorkflow',
- 'OperateEnableWorkflows',
- 'CreateCalendar',
- 'ImportWorkflows',
- 'GetWorkflow',
- 'OperateUnskipJobExecution',
- 'ExportWorkflows',
- 'GetWorkflowDAG',
- 'ListWorkflowVersions',
- 'OperateHoldJobExecution',
- 'DeleteCalendar',
- 'UpdateWorkflowDAG',
- 'OperateUnholdJobExecution',
- 'OperateHoldWorkflowExecution',
- 'OperateBackfillWorkflow',
- 'DeleteWorkflows',
- 'UpdateCalendar',
- 'OperateRetryWorkflowExecution',
- 'UpdateWorkflowDAGVersion',
- 'GetCalendar',
- 'GetWorkflowExecutionDAG',
- 'ListWorkflows',
- 'OperateMarkSuccessJobExecution',
- 'CreateWorkflow',
- 'OperateDisableWorkflows',
- 'OperateUnholdWorkflowExecution',
- 'OperateExecuteWorkflow',
- 'OperateStopWorkflowExecution',
- 'ListCalendars',
- 'GetWorkflowDAGPreview',
- 'ListWorkflowExecutions',
- 'DeleteWorkflow',
+ 'ListK8sResource', 'GetLogEvent', 'ImportJobs', 'ListRegions', 'ListRegionZone', 'ListCalendarNames', 'ListScheduleEvent', 'ListAlarmEvent', 'ListScheduleTimes', 'ImportCalendar', 'ExportJobs', 'GetLog', 'OperateMarkSuccessWorkflowExecution', 'OperateSkipJobExecution', 'UpdateWorkflow', 'OperateEnableWorkflows', 'CreateCalendar', 'ImportWorkflows', 'GetWorkflow', 'OperateUnskipJobExecution',
+ 'ExportWorkflows', 'GetWorkflowDAG', 'ListWorkflowVersions', 'OperateHoldJobExecution', 'DeleteCalendar', 'UpdateWorkflowDAG', 'OperateUnholdJobExecution', 'OperateHoldWorkflowExecution', 'OperateBackfillWorkflow', 'DeleteWorkflows', 'UpdateCalendar', 'OperateRetryWorkflowExecution', 'UpdateWorkflowDAGVersion', 'GetCalendar', 'GetWorkflowExecutionDAG', 'ListWorkflows', 'OperateMarkSuccessJobExecution', 'CreateWorkflow', 'OperateDisableWorkflows', 'OperateUnholdWorkflowExecution',
+ 'OperateExecuteWorkflow', 'OperateStopWorkflowExecution', 'ListCalendars', 'GetWorkflowDAGPreview', 'ListWorkflowExecutions', 'DeleteWorkflow', 'CreateApp', 'CreateContact', 'CreateDatasource', 'CreateExecutorGroup', 'DeleteContact', 'DeleteDatasource', 'DeleteExecutorGroup', 'GetPageLog', 'ListContacts', 'ListDatasources', 'ListExecutorGroup', 'OperateConnectDatasource', 'UpdateContact', 'UpdateDatasource',
+ 'UpdateExecutorGroup', 'UpdateJobExecution',
],
- ],
- [
- 'id' => 0,
- 'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'ListDatasources',
- 'OperateConnectDatasource',
- 'DeleteDatasource',
- 'UpdateDatasource',
- 'UpdateJobExecution',
- 'CreateDatasource',
- ],
+ 'title' => '其他',
+ 'id' => 317308,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateCluster' => [
- 'summary' => '创建集群。',
- 'methods' => [
- 'post',
+ 'CreateApp' => [
+ 'summary' => '创建应用。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227447',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$'],
+ ],
+ [
+ 'name' => 'AccessToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '可接入应用Token。', 'type' => 'string', 'required' => false, 'example' => 'ltk1ZXHv6LvibZypFkPHzRA', 'maxLength' => 32, 'minLength' => 6, 'pattern' => '^[\\w.-]+$'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['description' => '标题。', 'type' => 'string', 'required' => true, 'example' => 'Test', 'maxLength' => 64, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'MaxConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务执行队列大小。'."\n"
+ .'> 一个应用最多同时运行的任务实例个数，超过并发数的任务实例不会丢弃，会放在队列中等待执行', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'EnableLog',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否开启日志。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'LabelRouteStrategy',
+ 'in' => 'formData',
+ 'schema' => ['description' => '标签路由策略。', 'type' => 'integer', 'format' => 'int32', 'required' => false],
+ ],
+ [
+ 'name' => 'AppType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '应用类型',
+ 'description' => '应用类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'default' => '1',
+ 'enum' => ['1', '2', '3', '4'],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppGroupId' => ['description' => '任务分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'AccessToken' => ['description' => '访问令牌。', 'type' => 'string', 'example' => '4a0fae835cd741f3b12376d8a5a8e549v3'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
+ ],
+ [
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
+ ],
+ [
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AppGroupId\\": 10,\\n \\"AccessToken\\": \\"4a0fae835cd741f3b12376d8a5a8e549v3\\"\\n }\\n}","type":"json"}]',
+ 'title' => '创建应用',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'],
+ ],
+ ],
+ ],
+ 'CreateCalendar' => [
+ 'summary' => '创建自定义日历',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。您可以调用[ListClusters](~~28147~~)查看集群的ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'CalendarName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => '日历名称', 'type' => 'string', 'required' => true, 'example' => 'workday'],
+ ],
+ [
+ 'name' => 'Year',
+ 'in' => 'formData',
+ 'schema' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2026'],
+ ],
+ [
+ 'name' => 'Months',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => '每个月的日历，JSON数组格式', 'type' => 'string', 'required' => true, 'example' => '['."\n"
+ .' {"month":1,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
+ .' {"month":2,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
+ .' {"month":3,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},'."\n"
+ .' {"month":4,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},'."\n"
+ .' {"month":5,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},'."\n"
+ .' {"month":6,"days":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},'."\n"
+ .' {"month":7,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},'."\n"
+ .' {"month":8,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},'."\n"
+ .' {"month":9,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},'."\n"
+ .' {"month":10,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
+ .' {"month":11,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
+ .' {"month":12,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}'."\n"
+ .']'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => '123456789'],
+ ],
+ ],
+ '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' => 'B880122A-B0E4-52E8-8F54-87DB7779EB74'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'CalendarName is already existed'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
+ ],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B880122A-B0E4-52E8-8F54-87DB7779EB74\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"CalendarName is already existed\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '创建日历',
+ 'description' => '创建自定义日历',
+ 'changeSet' => [],
+ ],
+ 'CreateCluster' => [
+ 'summary' => '创建集群。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -167,31 +285,18 @@
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '234193',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
],
'parameters' => [
[
'name' => 'ClusterName',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'qianxi-test-0812',
- ],
+ 'schema' => ['description' => '集群名称。', 'type' => 'string', 'required' => true, 'example' => 'qianxi-test-0812'],
],
[
'name' => 'VpcId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'VPC id',
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vpc-aa1a18236n90rqhuhhnhh',
- ],
+ 'schema' => ['title' => 'VPC id', 'description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-aa1a18236n90rqhuhhnhh'],
],
[
'name' => 'VSwitches',
@@ -204,22 +309,13 @@
'items' => [
'type' => 'object',
'properties' => [
- 'ZoneId' => [
- 'description' => '交换机所属的可用区ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-hangzhou-j',
- ],
- 'VSwitchId' => [
- 'description' => '交换机ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'vsw-2ze745n3r2sfqtahhubpl',
- ],
+ 'ZoneId' => ['description' => '交换机所属的可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j'],
+ 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-2ze745n3r2sfqtahhubpl'],
],
- 'required' => true,
+ 'required' => false,
+ 'description' => '',
],
- 'required' => true,
+ 'required' => false,
],
],
[
@@ -236,15 +332,9 @@
.'- scx.medium.x1。'."\n"
.'- scx.medium.x2。',
'type' => 'string',
- 'required' => true,
+ 'required' => false,
'example' => 'scx.dev.x1',
- 'enum' => [
- 'scx.dev.x1',
- 'scx.small.x1',
- 'scx.small.x2',
- 'scx.medium.x1',
- 'scx.medium.x2',
- ],
+ 'enum' => ['scx.dev.x1', 'scx.small.x1', 'scx.small.x2', 'scx.medium.x1', 'scx.medium.x2'],
],
],
[
@@ -254,11 +344,9 @@
'title' => '引擎类型，可选类型：xxljob',
'description' => '引擎类型，可选类型：xxljob。',
'type' => 'string',
- 'required' => true,
+ 'required' => false,
'example' => 'xxljob',
- 'enum' => [
- 'xxljob',
- ],
+ 'enum' => ['xxljob'],
],
],
[
@@ -272,20 +360,11 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Value' => [
- 'title' => '标签值',
- 'description' => '标签值',
- 'type' => 'string',
- 'required' => false,
- ],
- 'Key' => [
- 'title' => '标签键',
- 'description' => '标签键',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'Value' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'required' => false],
+ 'Key' => ['title' => '标签键', 'description' => '标签键', 'type' => 'string', 'required' => false],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
'maxItems' => 20,
@@ -301,10 +380,7 @@
'required' => false,
'example' => 'POSTPAY',
'default' => 'POSTPAY',
- 'enum' => [
- 'PREPAY',
- 'POSTPAY',
- ],
+ 'enum' => ['PREPAY', 'POSTPAY'],
],
],
[
@@ -317,26 +393,23 @@
'required' => false,
'example' => 'Year',
'default' => 'Month',
- 'enum' => [
- 'Year',
- 'Month',
- ],
+ 'enum' => ['Year', 'Month'],
],
],
[
'name' => 'Duration',
'in' => 'formData',
- 'schema' => [
- 'title' => '持续时间',
- 'description' => '持续时间',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '9',
- 'minimum' => '1',
- 'example' => '3',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '持续时间', 'description' => '持续时间', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9', 'minimum' => '1', 'example' => '3', 'default' => '1'],
+ ],
+ [
+ 'name' => 'ClusterType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '集群类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ [
+ 'name' => 'Source',
+ 'in' => 'formData',
+ 'schema' => ['title' => '来源', 'type' => 'string', 'example' => 'schedulerx'],
],
],
'responses' => [
@@ -349,102 +422,57 @@
'Data' => [
'type' => 'object',
'properties' => [
- 'OrderId' => [
- 'description' => '订单ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '229317760970086',
- ],
- 'ClusterId' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'example' => 'xxljob-b21969c2309',
- ],
+ 'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '229317760970086'],
+ 'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'xxljob-b21969c2309'],
],
+ 'description' => '',
],
- 'Code' => [
- 'title' => 'code',
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'INVALID_PARAMETER',
- ],
- 'Success' => [
- 'title' => '是否成功(前端要使用)',
- 'description' => '请求返回状态。'."\n"
- .'- true：成功。'."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的<br />唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'B8733786-C045-59F1-8D79-99A52863F62D',
- ],
+ 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'INVALID_PARAMETER'],
+ 'Success' => ['title' => '是否成功(前端要使用)', 'description' => '请求返回状态。'."\n"
+ .'- true：成功。'."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的<br />唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'B8733786-C045-59F1-8D79-99A52863F62D'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"OrderId\\": 229317760970086,\\n \\"ClusterId\\": \\"xxljob-b21969c2309\\"\\n },\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"INVALID_PARAMETER\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"RequestId\\": \\"B8733786-C045-59F1-8D79-99A52863F62D\\"\\n}","type":"json"}]',
'title' => '创建集群',
- ],
- 'UpdateCluster' => [
- 'summary' => '更新集群。',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-04T09:16:51.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCluster'],
+ ],
],
+ ],
+ 'CreateContact' => [
+ 'summary' => '创建通知联系人',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -453,46 +481,34 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '227451',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREmseFDWH5S'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'ContactName',
'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => 'A short description of struct',
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['description' => '报警联系人名称。', 'type' => 'string', 'required' => true, 'example' => '陈睿', 'maxLength' => 100, 'minLength' => 1],
],
[
- 'name' => 'ClusterName',
+ 'name' => 'Type',
'in' => 'formData',
'schema' => [
+ 'description' => '联系人类型'."\n"
+ .'- IM:配置IM渠道通知联系人 ',
'type' => 'string',
- 'required' => false,
- 'maxLength' => 64,
- 'minLength' => 1,
- 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$',
+ 'required' => true,
+ 'example' => 'IM',
+ 'enum' => ['IM', 'WEBHOOK', 'SMS', 'MAIL'],
],
],
[
- 'name' => 'IpWhitelist',
+ 'name' => 'Config',
'in' => 'formData',
- 'schema' => [
- 'title' => '实例级别ip白名单',
- 'description' => '实例级别ip白名单',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.1.0/24',
- ],
+ 'schema' => ['description' => '渠道参数配置 JSON 字符串。IM 类型示例：{"channels":[{"channelType":"dingtalk","clientId":"xxx","clientSecret":"xxx","targetType":"group","targetId":"xxx","robotCode":"xxx"}]}', 'type' => 'string', 'required' => true, 'example' => '{"channels":[{"channelType":"dingtalk","clientId":"xxx","clientSecret":"xxx","targetType":"group","targetId":"xxx","robotCode":"xxx"}]}'],
],
],
'responses' => [
@@ -502,28 +518,18 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'EEF9AF15-AEEF-5E59-BF7B-BCBB119DC53F',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactId' => ['description' => '联系人Id', 'type' => 'integer', 'format' => 'int64', 'example' => '5000'],
+ ],
],
],
],
@@ -531,50 +537,35 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建联系人',
+ 'description' => '创建自定义联系人',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"EEF9AF15-AEEF-5E59-BF7B-BCBB119DC53F\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新集群',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ContactId\\": 5000\\n }\\n}","type":"json"}]',
],
- 'DeleteCluster' => [
- 'summary' => '释放删除集群。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateDatasource' => [
+ 'summary' => '创建数据源',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -583,25 +574,53 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'high',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '229999',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeCode' => '227447',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源名称', 'type' => 'string', 'required' => true, 'example' => 'myDatasouce', 'maxLength' => 100, 'minLength' => 6, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源名称', 'type' => 'string', 'required' => false, 'example' => 'my first datasource', 'maxLength' => 64, 'minLength' => 0],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'formData',
'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
+ 'description' => '数据源类型'."\n"
+ .'- 0: MySQL'."\n"
+ .'- 1: PostgreSQL',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'xxljob-a1804a3226d',
+ 'example' => '0',
+ 'enum' => ['0', '1'],
],
],
+ [
+ 'name' => 'ConnectionParams',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源连接参数，json格式', 'type' => 'string', 'required' => true, 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}'."\n"],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据库密码', 'type' => 'string', 'required' => true, 'example' => '***'],
+ ],
],
'responses' => [
200 => [
@@ -610,29 +629,18 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功：'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatasourceId' => ['description' => '数据源ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
],
],
],
@@ -640,77 +648,119 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建数据源',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '释放删除集群',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DatasourceId\\": 1\\n }\\n}","type":"json"}]',
],
- 'GetCluster' => [
- 'summary' => '获取集群详细信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateExecutorGroup' => [
+ 'summary' => '添加执行器组',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '232722',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse09FNQO'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-d6a5243b6fa',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'worker组名称', 'type' => 'string', 'required' => true, 'example' => 'group1'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'worker组描述。', 'type' => 'string', 'required' => false, 'example' => 'group1'],
+ ],
+ [
+ 'name' => 'WorkerType',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'worker类型', 'type' => 'string', 'required' => true, 'example' => 'openclaw'],
+ ],
+ [
+ 'name' => 'Protocol',
+ 'in' => 'formData',
+ 'schema' => ['description' => '后端协议。取值：'."\n"
+ ."\n"
+ .'- **HTTP**（默认值）：支持关联HTTPS、HTTP和QUIC监听。'."\n"
+ ."\n"
+ .'- **HTTPS**：支持关联HTTPS监听。'."\n"
+ ."\n"
+ .'- **gRPC**：关联HTTPS和QUIC监听。'."\n"
+ ."\n"
+ .'> **ServerGroupType**取值为**Fc**时，无需配置后端协议。', 'type' => 'string', 'required' => false, 'example' => 'HTTPS'],
+ ],
+ [
+ 'name' => 'Network',
+ 'in' => 'formData',
+ 'schema' => ['description' => '网络类型，public/private', 'type' => 'string', 'required' => false, 'example' => 'public'],
+ ],
+ [
+ 'name' => 'AuthType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '认证类型', 'type' => 'string', 'required' => false, 'example' => 'api_key'],
+ ],
+ [
+ 'name' => 'ApiKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户端密钥。', 'type' => 'string', 'required' => false, 'example' => 'HfGUG/Qf8qRCCWlv5RT6WA=='],
+ ],
+ [
+ 'name' => 'Workers',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'worker列表，json格式', 'type' => 'string', 'required' => true, 'example' => '[{"address":"http://47.111.188.191:18789"}]'],
+ ],
+ [
+ 'name' => 'IntegrationType',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'AutoScale',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自动扩缩容', 'type' => 'boolean'],
+ ],
+ [
+ 'name' => 'CmsWorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'XAttrs',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -720,227 +770,29 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter format error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
+ 'description' => '查询结果。',
'type' => 'object',
'properties' => [
- 'ClusterId' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'example' => 'xxljob-e0d018c6df8',
- ],
- 'ClusterName' => [
- 'description' => '集群名称。',
- 'type' => 'string',
- 'example' => 'xxl-job-test-1730427575152',
- ],
- 'ClusterSpec' => [
- 'description' => '集群规格，可选规格如下：'."\n"
- .'- scx.dev.x1。'."\n"
- .'- scx.small.x1。'."\n"
- .'- scx.small.x2。'."\n"
- .'- scx.medium.x1。'."\n"
- .'- scx.medium.x2。',
- 'type' => 'string',
- 'example' => 'scx.small.x2',
- ],
- 'ProductType' => [
- 'description' => '产品版本。'."\n"
- ."\n"
- .'- 1：开发版。'."\n"
- ."\n"
- .'- 2：专业版。'."\n"
- ."\n"
- .'- 3：企业版。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'EngineType' => [
- 'description' => '引擎类型，可选类型：xxljob。',
- 'type' => 'string',
- 'example' => 'xxljob',
- ],
- 'EngineVersion' => [
- 'description' => '引擎版本。',
- 'type' => 'string',
- 'example' => '2.0.0',
- ],
- 'Status' => [
- 'description' => '集群状态。'."\n"
- ."\n"
- .'- 1：创建中。'."\n"
- .'- 2：运行中。'."\n"
- .'- 3：重启中。'."\n"
- .'- 4：销毁中。'."\n"
- .'- 5：创建失败。'."\n"
- .'- 6：停机。'."\n"
- .'- 99：删除。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-10-29 15:56:36',
- ],
- 'EndTime' => [
- 'description' => '过期时间。',
- 'type' => 'string',
- 'example' => '2024-10-29 15:56:36',
- ],
- 'IntranetDomain' => [
- 'description' => '内网域名。',
- 'type' => 'string',
- 'example' => 'http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com',
- ],
- 'InternetDomain' => [
- 'description' => '公网域名。'."\n"
- .'> 暂不支持',
- 'type' => 'string',
- 'example' => '暂无',
- ],
- 'ChargeType' => [
- 'description' => '付费方式。 取值说明：'."\n"
- .'- PREPAY：包年包月。'."\n"
- .'- POSTPAY：按量付费。',
- 'type' => 'string',
- 'example' => 'POSTPAY',
- ],
- 'KubeConfig' => [
- 'description' => 'K8s服务器的配置信息。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "vSwitchIdList": ['."\n"
- .' "xxx",'."\n"
- .' "xxx"'."\n"
- .' ],'."\n"
- .' "cpu": xxx,'."\n"
- .' "cpuUnit": "xxx",'."\n"
- .' "diskCapacity": xxx,'."\n"
- .' "memoryCapacity": xxx,'."\n"
- .' "zoneIds": ['."\n"
- .' "xxx",'."\n"
- .' "xxx"'."\n"
- .' ],'."\n"
- .' "securityGroupList": ['."\n"
- .' "xxx"'."\n"
- .' ],'."\n"
- .' "eniCrossZone": "xxx",'."\n"
- .' "regionId": "xxx",'."\n"
- .' "instanceCount": xxx,'."\n"
- .' "vpcId": "xxx",'."\n"
- .' "memoryUnit": "xxx",'."\n"
- .' "diskType": "xxx",'."\n"
- .' "appClusterId": "xxx"'."\n"
- .'}'."\n",
- ],
- 'JobNum' => [
- 'description' => '该规格下最大任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'WorkerNum' => [
- 'description' => '执行器数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'VSwitches' => [
- 'description' => '可用区交换机信息。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ZoneId' => [
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-k',
- ],
- 'VSwitchId' => [
- 'description' => '虚拟交换机ID。',
- 'type' => 'string',
- 'example' => 'vsw-8vbf1n216nshvfjdyff8a',
- ],
- ],
- ],
- ],
- 'VpcId' => [
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-bp1fiz967u39lt8yuxcs0',
- ],
- 'MaxJobNum' => [
- 'description' => '该规格下最大任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'Spm' => [
- 'description' => '每分钟调度峰值。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Zones' => [
- 'description' => '可用区列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '可用区。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-i',
- ],
- ],
- 'VersionLifecycle' => [
- 'type' => 'string',
- ],
- 'MaxWorkflowNum' => [
- 'title' => '最大支持的工作流个数',
- 'description' => '最大支持的工作流个数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'WorkflowNum' => [
- 'title' => '当前工作流个数',
- 'description' => '当前工作流个数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'IpWhitelist' => [
- 'title' => 'ip白名单，多个以英文逗号分隔',
- 'description' => 'ip白名单，多个以英文逗号分隔',
- 'type' => 'string',
- 'example' => '192.168.1.0/24',
- ],
- 'Tags' => [
- 'type' => 'object',
- ],
+ 'WorkerId' => ['description' => '部署任务Worker ID。此处ID可通过[ListWorkerResource](~~2712224~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'example' => 'ins-95mfvqrtg6fkijt1uko000'],
+ 'Name' => ['description' => '工作流名称', 'type' => 'string', 'example' => 'myWorkflow'],
+ 'Description' => ['description' => '工作流描述', 'type' => 'string', 'example' => 'my first workflow'],
+ 'WorkerType' => ['description' => '执行器类型', 'type' => 'string', 'example' => 'k8s_service'],
+ 'Workers' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
+ 'AuthType' => ['description' => '产品下的设备接入物联网平台的认证方式。'."\n"
+ ."\n"
+ .'- **secret**：使用设备密钥进行设备身份认证。'."\n"
+ .'- **id2**：使用物联网设备身份认证ID²。'."\n"
+ .'- **x509**：使用设备X.509证书进行设备身份认证。', 'type' => 'string', 'example' => 'md5_spell'],
+ 'Protocol' => ['description' => '域名支持的协议类型。HTTP：仅支持HTTP协议。HTTPS：仅支持HTTPS协议。HTTP,HTTPS：支持HTTP及HTTPS协议。', 'type' => 'string', 'example' => 'All'],
+ 'Network' => ['description' => '域名规则。', 'type' => 'string', 'example' => 'NORMAL'],
+ 'FailedService' => ['description' => '导入失败的k8s服务', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
],
],
],
@@ -949,134 +801,74 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建执行器组',
+ 'description' => '手动导入执行器',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ClusterId\\": \\"xxljob-e0d018c6df8\\",\\n \\"ClusterName\\": \\"xxl-job-test-1730427575152\\",\\n \\"ClusterSpec\\": \\"scx.small.x2\\",\\n \\"ProductType\\": 2,\\n \\"EngineType\\": \\"xxljob\\",\\n \\"EngineVersion\\": \\"2.0.0\\",\\n \\"Status\\": 2,\\n \\"CreateTime\\": \\"2024-10-29 15:56:36\\",\\n \\"EndTime\\": \\"2024-10-29 15:56:36\\",\\n \\"IntranetDomain\\": \\"http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"暂无\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"KubeConfig\\": \\"{\\\\n \\\\\\"vSwitchIdList\\\\\\": [\\\\n \\\\\\"xxx\\\\\\",\\\\n \\\\\\"xxx\\\\\\"\\\\n ],\\\\n \\\\\\"cpu\\\\\\": xxx,\\\\n \\\\\\"cpuUnit\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"diskCapacity\\\\\\": xxx,\\\\n \\\\\\"memoryCapacity\\\\\\": xxx,\\\\n \\\\\\"zoneIds\\\\\\": [\\\\n \\\\\\"xxx\\\\\\",\\\\n \\\\\\"xxx\\\\\\"\\\\n ],\\\\n \\\\\\"securityGroupList\\\\\\": [\\\\n \\\\\\"xxx\\\\\\"\\\\n ],\\\\n \\\\\\"eniCrossZone\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"regionId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"instanceCount\\\\\\": xxx,\\\\n \\\\\\"vpcId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"memoryUnit\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"diskType\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"appClusterId\\\\\\": \\\\\\"xxx\\\\\\"\\\\n}\\\\n\\",\\n \\"JobNum\\": 100,\\n \\"WorkerNum\\": 10,\\n \\"VSwitches\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchId\\": \\"vsw-8vbf1n216nshvfjdyff8a\\"\\n }\\n ],\\n \\"VpcId\\": \\"vpc-bp1fiz967u39lt8yuxcs0\\",\\n \\"MaxJobNum\\": 1000,\\n \\"Spm\\": 10,\\n \\"Zones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"VersionLifecycle\\": \\"\\",\\n \\"MaxWorkflowNum\\": 100,\\n \\"WorkflowNum\\": 20,\\n \\"IpWhitelist\\": \\"192.168.1.0/24\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取集群详细信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkerId\\": 0,\\n \\"Name\\": \\"myWorkflow\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"WorkerType\\": \\"k8s_service\\",\\n \\"Workers\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\",\\n \\"AuthType\\": \\"md5_spell\\",\\n \\"Protocol\\": \\"All\\",\\n \\"Network\\": \\"NORMAL\\",\\n \\"FailedService\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\"\\n }\\n}","type":"json"}]',
],
- 'ListClusters' => [
- 'summary' => '查询实例列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateExecutors' => [
+ 'summary' => '手动导入执行器',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227435',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse09FNQO'],
],
'parameters' => [
[
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页的条目数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'name' => 'ClusterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Tag',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Value' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'Key' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 21,
- ],
+ 'name' => 'AppName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'ClusterId',
- 'in' => 'query',
+ 'name' => 'WorkerType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '集群ID。',
+ 'description' => '执行器类型',
'type' => 'string',
- 'required' => false,
- 'example' => 'xxljob-d6a5243b6fa',
+ 'required' => true,
+ 'example' => 'k8s_service',
+ 'enum' => ['xxljob', 'dify_workflow', 'http_domain', 'k8s_service'],
],
],
[
- 'name' => 'ClusterName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cluster-test',
- ],
+ 'name' => 'Workers',
+ 'in' => 'formData',
+ 'schema' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'required' => true, 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
],
],
'responses' => [
@@ -1086,182 +878,22 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589',
- ],
- 'Message' => [
- 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'Records' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'title' => '运行状态 1. 创建中 2. 运行中 3. 重启中 4. 销毁中 5.创建失败 6.停机',
- 'description' => '集群状态。'."\n"
- ."\n"
- .'- 1：创建中。'."\n"
- .'- 2：运行中。'."\n"
- .'- 3：重启中。'."\n"
- .'- 4：销毁中。'."\n"
- .'- 5：创建失败。'."\n"
- .'- 6：停机。'."\n"
- .'- 99：删除。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'VersionLifecycle' => [
- 'type' => 'string',
- ],
- 'EngineVersion' => [
- 'title' => '引擎版本',
- 'description' => '引擎版本。',
- 'type' => 'string',
- 'example' => '2.0.0',
- ],
- 'EndTime' => [
- 'description' => '过期时间。',
- 'type' => 'string',
- 'example' => '2024-10-29 15:56:36',
- ],
- 'ClusterId' => [
- 'title' => '集群ID',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'example' => 'xxljob-c20f7ec9a78',
- ],
- 'InternetDomain' => [
- 'title' => '访问方式 公网 ',
- 'description' => '公网域名。'."\n"
- .'> 暂不支持',
- 'type' => 'string',
- 'example' => '暂无',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-10-29 15:56:36',
- ],
- 'ProductType' => [
- 'title' => '产品版本 1 开发版 2 专业版',
- 'description' => '产品版本 。'."\n"
- .'- 1 开发版 。'."\n"
- .'- 2 专业版 。'."\n"
- .'- 3 企业版。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ClusterSpec' => [
- 'title' => '实例规格',
- 'description' => '实例规格。',
- 'type' => 'string',
- 'example' => 'scx.small.x2',
- ],
- 'SpInstanceId' => [
- 'description' => '订单资产实例ID。',
- 'type' => 'string',
- 'example' => 'mse_schedulerxpost_public_cn-htq402sak02',
- ],
- 'VpcId' => [
- 'description' => 'VPC ID。',
- 'type' => 'string',
- 'example' => 'vpc-bp1fxort6ag5h9752i305',
- ],
- 'ChargeType' => [
- 'description' => '付费方式。 取值说明：'."\n"
- .'- PREPAY：包年包月。'."\n"
- .'- POSTPAY：按量付费。',
- 'type' => 'string',
- 'example' => 'PREPAY',
- ],
- 'ClusterName' => [
- 'description' => '集群名称。',
- 'type' => 'string',
- 'example' => 'xxl-job-test-1730427510169',
- ],
- 'EngineType' => [
- 'title' => '引擎类型',
- 'description' => '引擎类型。',
- 'type' => 'string',
- 'example' => 'xxljob',
- ],
- 'VSwitches' => [
- 'description' => '可用区交换机信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '结果集。',
- 'type' => 'object',
- 'properties' => [
- 'ZoneId' => [
- 'description' => '可用区。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou-h',
- ],
- 'VSwitchId' => [
- 'description' => '虚拟交换机ID。',
- 'type' => 'string',
- 'example' => 'vsw-8vbl54xzux86usy61r5zm',
- ],
- ],
- ],
- ],
- 'IntranetDomain' => [
- 'title' => '访问方式 内网',
- 'description' => '内网域名。',
- 'type' => 'string',
- 'example' => 'http://xxljob-b9e19e46c4e.schedulerx.mse.aliyuncs.com',
- ],
- 'Tags' => [
- 'type' => 'object',
- ],
- ],
- ],
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
+ 'WorkerId' => ['description' => '部署任务Worker ID。此处ID可通过[ListWorkerResource](~~2712224~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'example' => 'ins-95mfvqrtg6fkijt1uko000'],
+ 'AppGroupId' => ['description' => '任务分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'test-app'."\n"],
+ 'AppType' => ['description' => '应用类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WorkerType' => ['description' => '执行器类型', 'type' => 'string', 'example' => 'k8s_service'],
+ 'Workers' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
+ 'FailedService' => ['description' => '导入失败的k8s服务', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
],
],
],
@@ -1270,165 +902,355 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '手动导入执行器',
+ 'description' => '手动导入执行器',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"Status\\": 1,\\n \\"VersionLifecycle\\": \\"\\",\\n \\"EngineVersion\\": \\"2.0.0\\",\\n \\"EndTime\\": \\"2024-10-29 15:56:36\\",\\n \\"ClusterId\\": \\"xxljob-c20f7ec9a78\\",\\n \\"InternetDomain\\": \\"暂无\\",\\n \\"CreateTime\\": \\"2024-10-29 15:56:36\\",\\n \\"ProductType\\": 1,\\n \\"ClusterSpec\\": \\"scx.small.x2\\",\\n \\"SpInstanceId\\": \\"mse_schedulerxpost_public_cn-htq402sak02\\",\\n \\"VpcId\\": \\"vpc-bp1fxort6ag5h9752i305\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"ClusterName\\": \\"xxl-job-test-1730427510169\\",\\n \\"EngineType\\": \\"xxljob\\",\\n \\"VSwitches\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VSwitchId\\": \\"vsw-8vbl54xzux86usy61r5zm\\"\\n }\\n ],\\n \\"IntranetDomain\\": \\"http://xxljob-b9e19e46c4e.schedulerx.mse.aliyuncs.com\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"Total\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50\\n }\\n}","type":"json"}]',
- 'title' => '查询实例列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkerId\\": 0,\\n \\"AppGroupId\\": 0,\\n \\"AppType\\": 1,\\n \\"WorkerType\\": \\"k8s_service\\",\\n \\"Workers\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\",\\n \\"FailedService\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\"\\n }\\n}","type":"json"}]',
],
- 'CreateApp' => [
- 'summary' => '创建应用。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateJob' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'riskType' => 'none',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeCode' => '227447',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeCode' => '227438',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-job', 'maxLength' => 200, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'test', 'maxLength' => 300],
+ ],
+ [
+ 'name' => 'JobType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '集群ID。',
+ 'description' => '任务类型',
'type' => 'string',
'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
+ 'docRequired' => true,
+ 'example' => 'xxljob',
+ 'enum' => [
+ 'xxljob', 'dify_workflow', 'script_groovy', 'script_shell', 'script_python', 'script_php', 'script_nodejs', 'script_powershell', 'http', 'status_branch', 'condition_branch', 'dependent', 'manual', 'callback_branch', 'script_cmd', 'sql', 'dify_agent', 'openclaw', 'bailian', 'a2a',
+ 'langgraph', 'hermes', 'matrix', 'qwenpaw',
+ ],
],
],
[
- 'name' => 'AppName',
+ 'name' => 'RouteStrategy',
+ 'in' => 'formData',
+ 'schema' => ['description' => '路由策略。具体取值如下：'."\n"
+ .'- 1: 轮询'."\n"
+ .'- 2: 随机'."\n"
+ .'- 3: 第一个'."\n"
+ .'- 4: 最后一个'."\n"
+ .'- 5: 最不经常使用'."\n"
+ .'- 6: 最近最久未使用'."\n"
+ .'- 7: 一致性哈希'."\n"
+ .'- 8: 分片广播', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '9', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务参数', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'MaxConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['description' => '最大并发数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'MaxAttempt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '错误最大重试次数，根据业务需求填写', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'default' => '0'],
+ ],
+ [
+ 'name' => 'AttemptInterval',
+ 'in' => 'formData',
+ 'schema' => ['description' => '错误重试间隔，单位s，默认值为30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'default' => '30'],
+ ],
+ [
+ 'name' => 'JobHandler',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'jobhandler名称', 'type' => 'string', 'required' => false, 'example' => 'testJobVoidHandler'],
+ ],
+ [
+ 'name' => 'Script',
+ 'in' => 'formData',
+ 'schema' => ['title' => '非BEAN任务类型，通过该字段传脚本内容', 'description' => '非BEAN任务类型，通过该字段传脚本内容', 'type' => 'string', 'required' => false, 'example' => 'echo "hello world"'],
+ ],
+ [
+ 'name' => 'TimeType',
'in' => 'formData',
'schema' => [
- 'description' => '应用名。',
- 'type' => 'string',
+ 'description' => '时间类型：'."\n"
+ .'- -1: none<br/>'."\n"
+ .'- 1：cron<br/>'."\n"
+ .'- 3：fix_rate<br/>'."\n"
+ .'- 5：one_time<br/>'."\n"
+ .'- 100:：api',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
'docRequired' => true,
- 'example' => 'test-app',
- 'maxLength' => 64,
- 'minLength' => 1,
- 'pattern' => '^[0-9a-zA-Z_-]+$',
+ 'example' => '-1',
+ 'enum' => ['-1', '1', '2', '3', '5', '100'],
],
],
[
- 'name' => 'AccessToken',
+ 'name' => 'TimeExpression',
'in' => 'formData',
'schema' => [
- 'description' => '可接入应用Token。',
+ 'description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
+ .'- **none**：无需填写'."\n"
+ .'- **cron**：填写标准的cron表达式，支持在线验证。'."\n"
+ .'- **api**：无需填写'."\n"
+ .'- **fixed_rate**：填写具体固定频率值，单位s。如200表示每隔200s触发一次。'."\n"
+ .'- **one_time**: 填写调度时间（yyyy-MM-dd HH:mm:ss）或者时间戳（毫秒），比如"2022-10-10 10:10:00"',
'type' => 'string',
'required' => false,
- 'example' => 'ltk1ZXHv6LvibZypFkPHzRA',
- 'maxLength' => 32,
- 'minLength' => 6,
- 'pattern' => '^[\\w.-]+$',
+ 'example' => '0 0 4 ? * Mon/1',
+ 'enum' => [],
],
],
[
- 'name' => 'Title',
+ 'name' => 'Calendar',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'cron类型可以选择填写自定义日历。', 'type' => 'string', 'required' => false, 'example' => 'workday'],
+ ],
+ [
+ 'name' => 'Timezone',
+ 'in' => 'formData',
+ 'schema' => ['description' => '时区', 'type' => 'string', 'required' => false, 'example' => 'GMT+8'],
+ ],
+ [
+ 'name' => 'StartTimeType',
'in' => 'formData',
'schema' => [
- 'description' => '标题。',
+ 'title' => '开始时间类型',
+ 'description' => '开始时间类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => ['1', '2', '3', '4'],
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1701310327000'],
+ ],
+ [
+ 'name' => 'XAttrs',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '如果是k8s任务类型，需要配置该参数'."\n"
+ .'Job任务：{"resource":"job"}'."\n"
+ .'Shell任务：{"image":"busybox","resource":"shell"}'."\n",
+ 'description' => '如果是k8s任务类型，需要配置该参数'."\n"
+ .'Job任务：{"resource":"job"}'."\n"
+ .'Shell任务：{"image":"busybox","resource":"shell"}'."\n",
'type' => 'string',
- 'required' => true,
- 'example' => '测试应用',
- 'maxLength' => 64,
- 'minLength' => 1,
+ 'required' => false,
+ 'example' => '{"resource":"job"}',
+ 'enum' => [],
],
],
[
- 'name' => 'MaxConcurrency',
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => ['description' => '优先级:'."\n"
+ .'- 1: 低'."\n"
+ .'- 5: 中'."\n"
+ .'- 10: 高'."\n"
+ .'- 15: 非常高', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '5'],
+ ],
+ [
+ 'name' => 'NoticeConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '任务执行队列大小。'."\n"
- .'> 一个应用最多同时运行的任务实例个数，超过并发数的任务实例不会丢弃，会放在队列中等待执行',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '报警配置',
+ 'description' => '通知配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimeoutEnable' => ['description' => '超时报警开关。取值如下：'."\n"
+ ."\n"
+ .'- **true**：开启'."\n"
+ ."\n"
+ .'- **false**：关闭', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ 'Timeout' => ['description' => '超时时间，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'default' => '7200'],
+ 'TimeoutKillEnable' => ['description' => '超时终止开关。取值如下：'."\n"
+ ."\n"
+ .'- **true**：开启超时终止开关。'."\n"
+ .'- **false**：关闭超时终止开关。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ 'SuccessNotice' => ['description' => '成功通知开关。取值如下：'."\n"
+ ."\n"
+ .'- true：开启。'."\n"
+ .'- false：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'FailEnable' => ['description' => '失败报警开关。取值如下：'."\n"
+ ."\n"
+ .'- **true**：开启失败报警开关。'."\n"
+ .'- **false**：关闭失败报警开关。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ 'FailLimitTimes' => ['description' => '连续失败次数。'."\n"
+ .'> 只有连续失败超过配置次数才会收到报警。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ 'MissWorkerEnable' => ['description' => '是否开启无可用机器报警。'."\n"
+ .'- **true**：开启无可用机器报警开关。'."\n"
+ .'- **false**：关闭无可用机器报警开关。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'SendChannel' => ['description' => '通知渠道,取值如下：'."\n"
+ .' - 短信：sms'."\n"
+ .' - 电话：phone'."\n"
+ .'- 邮件：mail'."\n"
+ .'- webhook：webhook'."\n"
+ .'> 配置多个通知渠道请用逗号分割', 'type' => 'string', 'required' => false, 'example' => 'mail'],
+ 'EndEarlyEnable' => ['title' => '提前结束告警开关', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => ''],
+ 'EndEarly' => ['title' => '提前结束阈值，单位秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'description' => ''],
+ ],
'required' => false,
- 'example' => '10',
+ 'example' => '1',
],
],
[
- 'name' => 'EnableLog',
+ 'name' => 'NoticeContacts',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '通知联系人配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactType' => [
+ 'description' => '通知对象类型,取值如下：'."\n"
+ ."\n"
+ .'- 1：报警联系人'."\n"
+ ."\n"
+ .'- 2：报警联系人组',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => ['1', '2', '3'],
+ ],
+ 'Name' => ['description' => '报警联系人名称/报警联系组名称', 'type' => 'string', 'required' => false, 'example' => 'xiaoming'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ExecutorBlockStrategy',
'in' => 'formData',
'schema' => [
- 'description' => '是否开启日志。',
- 'type' => 'boolean',
+ 'description' => '客户端阻塞处理策略。'."\n"
+ .'- 1: 单机串行'."\n"
+ .'- 2: 忽略后续调度'."\n"
+ .'- 3: 覆盖之前调度',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'true',
- 'default' => 'false',
+ 'example' => '1',
+ 'enum' => ['1', '2', '3'],
],
],
[
- 'name' => 'LabelRouteStrategy',
+ 'name' => 'Status',
'in' => 'formData',
'schema' => [
+ 'description' => '任务状态，默认为启用状态。'."\n"
+ .'- 0: 禁用'."\n"
+ .'- 1: 启用',
'type' => 'integer',
'format' => 'int32',
'required' => false,
+ 'example' => '1',
+ 'enum' => ['0', '1'],
],
],
[
- 'name' => 'AppType',
+ 'name' => 'ChildJobId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '子任务id，多个id以逗号分隔', 'description' => '子任务id，多个id以逗号分隔', 'type' => 'string', 'required' => false, 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'Weight',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务权重', 'description' => '任务权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DependentStrategy',
'in' => 'formData',
'schema' => [
- 'title' => '应用类型',
- 'description' => '应用类型',
+ 'title' => '依赖策略',
+ 'description' => '依赖策略',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
+ 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8'],
+ ],
+ ],
+ [
+ 'name' => 'Coordinate',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '节点在工作流中的坐标',
+ 'description' => '节点在工作流中的坐标',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['title' => 'X坐标', 'description' => 'X坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100.0'],
+ 'Y' => ['title' => 'Y坐标', 'description' => 'Y坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100.0'],
+ 'Width' => ['title' => '宽度', 'description' => '宽度', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100.0'],
+ 'Height' => ['title' => '高度', 'description' => '高度', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '50.0'],
],
+ 'required' => false,
],
],
],
@@ -1438,44 +1260,17 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '返回结果。',
+ 'description' => '-',
'type' => 'object',
'properties' => [
- 'AppGroupId' => [
- 'description' => '任务分组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'AccessToken' => [
- 'description' => '访问令牌。',
- 'type' => 'string',
- 'example' => '4a0fae835cd741f3b12376d8a5a8e549v3',
- ],
+ 'JobId' => ['description' => '任务id', 'type' => 'integer', 'format' => 'int64', 'example' => '74'],
],
],
],
@@ -1484,50 +1279,43 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AppGroupId\\": 10,\\n \\"AccessToken\\": \\"4a0fae835cd741f3b12376d8a5a8e549v3\\"\\n }\\n}","type":"json"}]',
- 'title' => '创建应用',
- ],
- 'UpdateApp' => [
- 'summary' => '更新应用分组。',
- 'methods' => [
- 'post',
+ 'title' => '创建任务',
+ 'summary' => '创建任务。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-04T09:10:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-20T09:00:54.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-24T09:10:14.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-09T06:28:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-17T09:51:37.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": 74\\n }\\n}","type":"json"}]',
+ ],
+ 'CreateWorkflow' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1536,329 +1324,104 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227448',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeCode' => '227447',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- 'maxLength' => 64,
- 'minLength' => 1,
- 'pattern' => '^[0-9a-zA-Z_-]+$',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxl-job-executor-sample', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$'],
],
[
- 'name' => 'AccessToken',
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => '登录态访问令牌。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f312159702f4469585586ed5a6904163v3',
- 'maxLength' => 32,
- 'minLength' => 6,
- 'pattern' => '^[\\w.-]+$',
- ],
+ 'schema' => ['description' => '工作流名称', 'type' => 'string', 'required' => true, 'example' => 'my-workflow', 'maxLength' => 100, 'minLength' => 6, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
- 'name' => 'Title',
+ 'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'description' => '标题内容。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '测试应用',
- 'maxLength' => 64,
- 'minLength' => 1,
- ],
+ 'schema' => ['description' => '工作流描述', 'type' => 'string', 'required' => false, 'example' => 'my first workflow for data analyse', 'maxLength' => 64, 'minLength' => 0],
],
[
- 'name' => 'MaxConcurrency',
+ 'name' => 'TimeType',
'in' => 'formData',
'schema' => [
- 'description' => '任务执行队列大小。'."\n"
- .'> 一个应用最多同时运行的任务实例个数，超过并发数的任务实例不会丢弃，会放在队列中等待执行',
+ 'description' => '时间类型：'."\n"
+ .'- -1: none<br/>'."\n"
+ .'- 1：cron<br/>'."\n"
+ .'- 100:：api',
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'example' => '10',
+ 'example' => '1',
+ 'default' => '-1',
+ 'enum' => ['-1', '1', '100'],
],
],
[
- 'name' => 'EnableLog',
+ 'name' => 'TimeExpression',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否开启日志。'."\n"
- ."\n"
- .'- true：开启。'."\n"
- ."\n"
- .'- false：关闭。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
+ .'- **none**：无需填写'."\n"
+ .'- **cron**：填写标准的cron表达式，支持在线验证。'."\n"
+ .'- **api**：无需填写', 'type' => 'string', 'required' => false, 'example' => '0 0 4 ? * Mon/1'."\n"],
],
[
- 'name' => 'LabelRouteStrategy',
+ 'name' => 'Calendar',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '39AA91C1-7BB7-5934-B15B-FD8E706D76C4',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ 'schema' => ['description' => 'cron类型可以选择填写自定义日历。', 'type' => 'string', 'required' => false, 'example' => 'workday'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ 'name' => 'Timezone',
+ 'in' => 'formData',
+ 'schema' => ['description' => '时区', 'type' => 'string', 'required' => false, 'example' => 'GMT+8'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39AA91C1-7BB7-5934-B15B-FD8E706D76C4\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新应用',
- ],
- 'GetApp' => [
- 'summary' => '获取指定应用。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '227431',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
+ 'name' => 'MaxConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工作流并发数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
- ],
- 'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-d6a5243b6fa',
- ],
+ 'name' => 'Status',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工作流状态，默认为禁用状态。'."\n"
+ .'- 0: 禁用'."\n"
+ .'- 1: 启用', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', 'type' => 'string', 'required' => false, 'example' => '123456789'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Not found: appName not found.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
- 'Success' => [
- 'description' => '是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '-',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '主键ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3402',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'AccessToken' => [
- 'description' => 'AccessToken。',
- 'type' => 'string',
- 'example' => '2f4ddeab8e344ed68e0402cf9b8502ffv3',
- ],
- 'Title' => [
- 'description' => '标题。',
- 'type' => 'string',
- 'example' => '测试应用',
- ],
- 'Creator' => [
- 'description' => '创建人。',
- 'type' => 'string',
- 'example' => '18582193685027xx',
- ],
- 'Updater' => [
- 'description' => '更新人。',
- 'type' => 'string',
- 'example' => '18582193685027xx',
- ],
- 'Leader' => [
- 'description' => 'Leader地址。',
- 'type' => 'string',
- 'example' => 'http://28.***.***.3:80'."\n",
- ],
- 'MaxJobs' => [
- 'description' => '最大任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'MaxConcurrency' => [
- 'description' => '最大并发数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'JobNum' => [
- 'description' => '任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'ExecutorNum' => [
- 'description' => '执行器数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'EnableLog' => [
- 'description' => '是否开启日志。'."\n"
- ."\n"
- .'- true：开启。'."\n"
- ."\n"
- .'- false：关闭。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'LabelRouteStrategy' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'AppType' => [
- 'title' => '应用类型',
- 'description' => '应用类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'WorkflowId' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
@@ -1867,50 +1430,34 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建工作流',
+ 'summary' => '创建工作流',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Not found: appName not found.\\",\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 3402,\\n \\"AppName\\": \\"test-app\\",\\n \\"AccessToken\\": \\"2f4ddeab8e344ed68e0402cf9b8502ffv3\\",\\n \\"Title\\": \\"测试应用\\",\\n \\"Creator\\": \\"18582193685027xx\\",\\n \\"Updater\\": \\"18582193685027xx\\",\\n \\"Leader\\": \\"http://28.***.***.3:80\\\\n\\",\\n \\"MaxJobs\\": 1000,\\n \\"MaxConcurrency\\": 100,\\n \\"JobNum\\": 100,\\n \\"ExecutorNum\\": 2,\\n \\"EnableLog\\": true,\\n \\"LabelRouteStrategy\\": 0,\\n \\"AppType\\": 1\\n }\\n}","type":"json"}]',
- 'title' => '获取指定应用',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkflowId\\": 10\\n }\\n}","type":"json"}]',
],
'DeleteApp' => [
'summary' => '删除应用分组。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1923,30 +1470,18 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227426',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
],
'responses' => [
@@ -1956,396 +1491,143 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF99C381-C8F6-5A8D-8C24-57F46B706D2D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除应用',
- ],
- 'ListApps' => [
- 'summary' => '获取应用列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'],
+ ],
],
+ ],
+ 'DeleteCalendar' => [
+ 'summary' => '删除指定日历',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227431',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeCode' => '227426',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'Title',
- 'in' => 'query',
- 'schema' => [
- 'description' => '标题。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试应用',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'name' => 'CalendarName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => '日历名称', 'type' => 'string', 'required' => true, 'example' => 'workday'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'name' => 'Year',
+ 'in' => 'formData',
+ 'schema' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Records' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '主键ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '43885',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'AccessToken' => [
- 'description' => 'AccessToken。',
- 'type' => 'string',
- 'example' => '2f4ddeab8e344ed68e0402cf9b8502ffv3',
- ],
- 'Title' => [
- 'description' => '标题。',
- 'type' => 'string',
- 'example' => '测试应用',
- ],
- 'Creator' => [
- 'description' => '创建人。',
- 'type' => 'string',
- 'example' => '1827811800555555',
- ],
- 'Updater' => [
- 'description' => '更新人。',
- 'type' => 'string',
- 'example' => '1827811800555555',
- ],
- 'Leader' => [
- 'description' => 'Leader地址。',
- 'type' => 'string',
- 'example' => 'http://28.***.***.3:80',
- ],
- 'MaxJobs' => [
- 'title' => '该字段废弃',
- 'description' => '最大任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'deprecated' => true,
- 'example' => '1000',
- ],
- 'MaxConcurrency' => [
- 'description' => '最大并发数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'JobNum' => [
- 'description' => '任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ExecutorNum' => [
- 'description' => '执行器数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'EnableLog' => [
- 'description' => '是否开启日志。'."\n"
- ."\n"
- .'- true：开启。'."\n"
- ."\n"
- .'- false：关闭。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'LabelRouteStrategy' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'AppType' => [
- 'title' => '应用类型',
- 'description' => '应用类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WorkerRegistry' => [
- 'title' => '手动注册执行器类型',
- 'description' => '手动注册执行器类型',
- 'type' => 'string',
- 'example' => 'k8s_service',
- ],
- 'WorkflowNum' => [
- 'title' => '当前工作流数量',
- 'description' => '当前工作流数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- 'default' => '0',
- ],
- ],
- ],
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF99C381-C8F6-5A8D-8C24-57F46B706D2D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '删除日历',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"RequestId\\": \\"2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"Id\\": 43885,\\n \\"AppName\\": \\"test-app\\",\\n \\"AccessToken\\": \\"2f4ddeab8e344ed68e0402cf9b8502ffv3\\",\\n \\"Title\\": \\"测试应用\\",\\n \\"Creator\\": \\"1827811800555555\\",\\n \\"Updater\\": \\"1827811800555555\\",\\n \\"Leader\\": \\"http://28.***.***.3:80\\",\\n \\"MaxJobs\\": 1000,\\n \\"MaxConcurrency\\": 100,\\n \\"JobNum\\": 10,\\n \\"ExecutorNum\\": 1,\\n \\"EnableLog\\": true,\\n \\"LabelRouteStrategy\\": 0,\\n \\"AppType\\": 1,\\n \\"WorkerRegistry\\": \\"k8s_service\\",\\n \\"WorkflowNum\\": 3\\n }\\n ],\\n \\"Total\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
- 'title' => '获取应用列表',
],
- 'ListAppNames' => [
- 'summary' => '获取应用名称列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteCluster' => [
+ 'summary' => '释放删除集群。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
+ 'operationType' => 'delete',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeCode' => '227427',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeCode' => '229999',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
],
'responses' => [
@@ -2355,171 +1637,62 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3881C59F-59F1-5B2E-8110-7D689CA9B207',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '主键。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'Title' => [
- 'description' => '标题。',
- 'type' => 'string',
- 'example' => '测试应用',
- ],
- 'AppGroupId' => [
- 'description' => '任务分组ID。',
- 'type' => 'string',
- 'example' => 'test-app'."\n",
- ],
- 'AppType' => [
- 'title' => '应用类型',
- 'description' => '应用类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WorkerRegistry' => [
- 'title' => '手动注册执行器类型',
- 'description' => '手动注册执行器类型',
- 'type' => 'string',
- 'example' => 'k8s_service',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功：'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3881C59F-59F1-5B2E-8110-7D689CA9B207\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 15,\\n \\"AppName\\": \\"test-app\\",\\n \\"Title\\": \\"测试应用\\",\\n \\"AppGroupId\\": \\"test-app\\\\n\\",\\n \\"AppType\\": 1,\\n \\"WorkerRegistry\\": \\"k8s_service\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取应用名称列表',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '释放删除集群',
+ 'changeSet' => [],
],
- 'ListLables' => [
- 'summary' => '获取executor的label列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteContact' => [
+ 'summary' => '删除通知联系人',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '251680',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREmseFDWH5S'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'JobId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '15',
- ],
+ 'name' => 'ContactName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '报警联系人姓名。', 'type' => 'string', 'required' => true, 'example' => '黄永丰'],
],
],
'responses' => [
@@ -2529,166 +1702,71 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n",
- 'type' => 'string',
- 'example' => '9079A828-9138-50F1-801E-F2BC3D222A06',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Label' => [
- 'description' => '标签。',
- 'type' => 'string',
- 'example' => 'gray',
- ],
- 'Online' => [
- 'description' => '是否在线。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Size' => [
- 'description' => '此标签下的机器数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'IsDesignated' => [
- 'description' => '是否指定。',
- 'type' => 'boolean',
- 'example' => 'true'."\n",
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除联系人',
+ 'description' => '删除自定义联系人',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9079A828-9138-50F1-801E-F2BC3D222A06\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Label\\": \\"gray\\",\\n \\"Online\\": true,\\n \\"Size\\": 2,\\n \\"IsDesignated\\": true\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取executor的label列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'ListExecutors' => [
- 'summary' => '查询Executor列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteDatasource' => [
+ 'summary' => '删除数据源',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227430',
- 'abilityTreeNodes' => [
- 'FEATUREmseWGXOHM',
- ],
+ 'abilityTreeCode' => '227426',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'JobId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '74',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Label',
- 'in' => 'query',
- 'schema' => [
- 'description' => '标签。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gray',
- ],
+ 'name' => 'DatasourceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源ID，可通过接口ListDatasources获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '195'],
],
],
'responses' => [
@@ -2698,132 +1776,44 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Address' => [
- 'description' => '机器地址。',
- 'type' => 'string',
- 'example' => 'http://192.168.1.10:9999/',
- ],
- 'Ip' => [
- 'description' => '机器IP。',
- 'type' => 'string',
- 'example' => '192.168.1.10',
- ],
- 'Port' => [
- 'description' => '端口号。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '9999',
- ],
- 'Label' => [
- 'description' => '标签。',
- 'type' => 'string',
- 'example' => 'gray',
- ],
- 'Version' => [
- 'description' => '版本号。',
- 'type' => 'string',
- 'example' => '2.0.2',
- ],
- 'Online' => [
- 'description' => '客户端是否在线。',
- 'type' => 'boolean',
- 'example' => 'true',
- 'default' => 'true',
- ],
- 'IsDesignated' => [
- 'description' => '是否指定。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Weight' => [
- 'title' => '任务权重',
- 'description' => '任务权重',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除数据源',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Address\\": \\"http://192.168.1.10:9999/\\",\\n \\"Ip\\": \\"192.168.1.10\\",\\n \\"Port\\": 9999,\\n \\"Label\\": \\"gray\\",\\n \\"Version\\": \\"2.0.2\\",\\n \\"Online\\": true,\\n \\"IsDesignated\\": true,\\n \\"Weight\\": 1\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询Executor列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF99C381-C8F6-5A8D-8C24-57F46B706D2D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'UpdateExecutors' => [
- 'summary' => '更新执行器',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteExecutorGroup' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2832,59 +1822,26 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmse09FNQO',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse09FNQO'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-a1804a3226d',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'WorkerType',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'description' => '执行器类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'k8s_service',
- 'enum' => [
- 'xxljob',
- 'dify_workflow',
- 'http_domain',
- 'k8s_service',
- ],
- ],
+ 'schema' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '83163'],
],
[
- 'name' => 'Workers',
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => '指定机器列表JSON格式列表',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]',
- ],
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -2894,285 +1851,125 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'WorkId' => [
- 'description' => '执行器ID',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AppGroupId' => [
- 'description' => '任务分组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1'."\n",
- ],
- 'AppType' => [
- 'description' => '应用类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WorkerType' => [
- 'description' => '执行器类型',
- 'type' => 'string',
- 'example' => 'k8s_service',
- ],
- 'Workers' => [
- 'description' => '指定机器列表JSON格式列表',
- 'type' => 'string',
- 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]',
- ],
- 'FailedService' => [
- 'description' => '导入失败的k8s服务',
- 'type' => 'string',
- 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除执行器组',
+ 'summary' => '删除执行器组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkId\\": 1,\\n \\"AppGroupId\\": 1,\\n \\"AppType\\": 1,\\n \\"WorkerType\\": \\"k8s_service\\",\\n \\"Workers\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\",\\n \\"FailedService\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\"\\n }\\n}","type":"json"}]',
- 'title' => '更新执行器',
- 'description' => '# 引入增强插件'."\n"
- ."\n"
- .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
- ."\n"
- .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
- ."\n"
- .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetExecutorConfig' => [
- 'summary' => '获取制定执行器配置信息',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteJobs' => [
+ 'summary' => '批量删除任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227430',
- 'abilityTreeNodes' => [
- 'FEATUREmseWGXOHM',
- ],
+ 'abilityTreeCode' => '227449',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU', 'FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-a1804a3226d',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'query',
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'JobIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74'],
'required' => true,
- 'example' => 'test-app',
+ 'docRequired' => true,
+ 'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'not support query script history, please upgrade engine version to 2.2.2+',
- ],
- 'Success' => [
- 'description' => '是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '查询结果。',
- 'type' => 'object',
- 'properties' => [
- 'Config' => [
- 'description' => '数据集成同步解决方案任务默认的全局配置内容（即对不同DDL消息类型配置的默认处理策略）。示例如下：'."\n"
- .'{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'."\n"
- ."\n"
- .'DDL消息类型如下：'."\n"
- .'- RENAMECOLUMN：重命名列。'."\n"
- .'- DROPTABLE：删除表。'."\n"
- .'- CREATETABLE：新建表。'."\n"
- .'- MODIFYCOLUMN：修改列类型。'."\n"
- .'- TRUNCATETABLE：清空表。'."\n"
- .'- DROPCOLUMN：删除列。'."\n"
- .'- ADDCOLUMN：新增列。'."\n"
- .'- RENAMETABLE：重命名表。'."\n"
- ."\n"
- .'DataWorks收到对应类型的DDL消息时，处理策略如下：'."\n"
- .'- WARNING：直接丢弃该消息，同时会在实时同步日志中记录告警信息，指明该消息因执行出错被丢弃。'."\n"
- .'- IGNORE：直接丢弃该消息，不再向目的端数据源发送。'."\n"
- .'- CRITICAL：实时同步任务直接显示出错状态并终止运行。'."\n"
- .'- NORMAL：将相应消息继续下发给目的端数据源，由目的端数据源来处理。因为不同目的端数据源对DDL消息处理策略可能会不同，因此DataWorks只执行转发操作。'."\n",
- 'type' => 'string',
- 'example' => '[{"cluster":"c2c619b5129e0400fa3df263b249622aa","namespace":"default","service":"xxljob-http-demo1-svc"}]',
- ],
- 'ExecutorType' => [
- 'description' => '执行器类型',
- 'type' => 'string',
- 'example' => 'k8s_service',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '91143E1D-E235-5BE0-9364-C2EE28FFB5A6'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Config\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"c2c619b5129e0400fa3df263b249622aa\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"default\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxljob-http-demo1-svc\\\\\\"}]\\",\\n \\"ExecutorType\\": \\"k8s_service\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取制定执行器配置信息',
- 'description' => '# 引入增强插件'."\n"
- ."\n"
- .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
- ."\n"
- .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
- ."\n"
- .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"91143E1D-E235-5BE0-9364-C2EE28FFB5A6\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '批量删除任务',
+ 'changeSet' => [],
],
- 'CreateExecutors' => [
- 'summary' => '手动导入执行器',
+ 'DeleteWorkflow' => [
+ 'summary' => '删除工作流',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3181,59 +1978,32 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmse09FNQO',
- ],
+ 'abilityTreeCode' => '227449',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkerType',
+ 'name' => 'WorkflowId',
'in' => 'formData',
- 'schema' => [
- 'description' => '执行器类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'k8s_service',
- 'enum' => [
- 'xxljob',
- 'dify_workflow',
- 'http_domain',
- 'k8s_service',
- ],
- ],
+ 'schema' => ['title' => '工作流ID', 'description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
- 'name' => 'Workers',
+ 'name' => 'DeleteJobs',
'in' => 'formData',
- 'schema' => [
- 'description' => '指定机器列表JSON格式列表',
- 'type' => 'string',
- 'required' => true,
- 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]',
- ],
+ 'schema' => ['title' => '是否删除工作流下的所有任务', 'description' => '是否删除工作流下的所有任务', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
],
'responses' => [
@@ -3243,1417 +2013,767 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'WorkerId' => [
- 'description' => '部署任务Worker ID。此处ID可通过[ListWorkerResource](~~2712224~~)接口获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'ins-95mfvqrtg6fkijt1uko000',
- ],
- 'AppGroupId' => [
- 'description' => '任务分组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'test-app'."\n",
- ],
- 'AppType' => [
- 'description' => '应用类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WorkerType' => [
- 'description' => '执行器类型',
- 'type' => 'string',
- 'example' => 'k8s_service',
- ],
- 'Workers' => [
- 'description' => '指定机器列表JSON格式列表',
- 'type' => 'string',
- 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]',
- ],
- 'FailedService' => [
- 'description' => '导入失败的k8s服务',
- 'type' => 'string',
- 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkerId\\": 0,\\n \\"AppGroupId\\": 0,\\n \\"AppType\\": 1,\\n \\"WorkerType\\": \\"k8s_service\\",\\n \\"Workers\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\",\\n \\"FailedService\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\"\\n }\\n}","type":"json"}]',
- 'title' => '手动导入执行器',
- 'description' => '手动导入执行器',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '删除工作流',
+ 'changeSet' => [],
],
- 'SyncJobs' => [
- 'summary' => '同步任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteWorkflows' => [
+ 'summary' => '批量删除工作流',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227445',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227449',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
],
'parameters' => [
[
- 'name' => 'OriginalClusterId',
+ 'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '原始集群ID，任务原本所在的集群。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-00ed7f0d742b1',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
[
- 'name' => 'OriginalAppName',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '原始应用名称，任务原本所在的应用。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-source',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
],
[
- 'name' => 'JobIds',
+ 'name' => 'WorkflowIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '任务ID列表。',
+ 'description' => '工作流ID列表',
'type' => 'array',
- 'items' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '56',
- ],
+ 'items' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
'required' => true,
'docRequired' => true,
],
],
[
- 'name' => 'TargetClusterId',
+ 'name' => 'DeleteJobs',
'in' => 'formData',
- 'schema' => [
- 'description' => '目标集群ID，任务需要同步到的集群。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-008bfb1541111',
- ],
- ],
- [
- 'name' => 'TargetAppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '目标应用名称，任务需要同步到的应用。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-target',
- ],
+ 'schema' => ['title' => '是否删除工作流下的所有任务', 'description' => '是否删除工作流下的所有任务', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Not found: appName not found.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '批量删除工作流',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Not found: appName not found.\\",\\n \\"RequestId\\": \\"6BCE89B3-E882-511D-9A75-D452A56EC4B1\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '同步任务',
],
- 'CreateJob' => [
- 'summary' => '创建任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ExportJobs' => [
+ 'summary' => '批量导出任务信息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'high',
+ 'operationType' => 'none',
+ 'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227438',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
+ 'abilityTreeCode' => '227429',
+ 'abilityTreeNodes' => ['FEATUREmse7UN7CQ'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-job',
- 'maxLength' => 200,
- 'minLength' => 1,
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'Description',
+ 'name' => 'JobIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '任务描述',
- 'type' => 'string',
+ 'description' => '任务ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74'],
'required' => false,
- 'example' => 'test',
- 'maxLength' => 300,
],
],
[
- 'name' => 'JobType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxljob',
- 'enum' => [
- 'xxljob',
- 'dify_workflow',
- 'script_groovy',
- 'script_shell',
- 'script_python',
- 'script_php',
- 'script_nodejs',
- 'script_powershell',
- 'http',
- 'status_branch',
- 'condition_branch',
- 'dependent',
- 'manual',
- 'callback_branch',
- 'script_cmd',
- 'sql',
- ],
- ],
- ],
- [
- 'name' => 'RouteStrategy',
+ 'name' => 'ExportJobType',
'in' => 'formData',
'schema' => [
- 'description' => '路由策略。具体取值如下：'."\n"
- .'- 1: 轮询'."\n"
- .'- 2: 随机'."\n"
- .'- 3: 第一个'."\n"
- .'- 4: 最后一个'."\n"
- .'- 5: 最不经常使用'."\n"
- .'- 6: 最近最久未使用'."\n"
- .'- 7: 一致性哈希'."\n"
- .'- 8: 分片广播',
+ 'description' => '导出任务类型，默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'docRequired' => true,
- 'maximum' => '9',
- 'minimum' => '1',
'example' => '1',
'default' => '1',
+ 'enum' => ['1'],
],
],
- [
- 'name' => 'Parameters',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'MaxConcurrency',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '最大并发数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => '返回内容。', 'type' => 'string', 'format' => 'byte', 'example' => '{'."\n"
+ .' "kind": "SchedulerXJobs",'."\n"
+ .' "type": "JSON",'."\n"
+ .' "version": "2.0",'."\n"
+ .' "content": ['."\n"
+ .' {'."\n"
+ .' "appName": "test-app",'."\n"
+ .' "groupId": "test-app",'."\n"
+ .' "description": "Test App",'."\n"
+ .' "jobConfigInfo": ['."\n"
+ .' {'."\n"
+ .' "jobHandler": "jobDemoHandler",'."\n"
+ .' "dataOffset": 0,'."\n"
+ .' "executeMode": "standalone",'."\n"
+ .' "monitorConfigInfo": {'."\n"
+ .' "alarmType": "CustomContacts",'."\n"
+ .' "failLimitTimes": 1,'."\n"
+ .' "failEnable": true,'."\n"
+ .' "failRate": 100,'."\n"
+ .' "timeoutKillEnable": false,'."\n"
+ .' "missWorkerEnable": false,'."\n"
+ .' "sendChannel": "webhook,mail",'."\n"
+ .' "timeoutEnable": true,'."\n"
+ .' "timeout": 300,'."\n"
+ .' "daysOfDeadline": 0,'."\n"
+ .' "successNotice": false'."\n"
+ .' },'."\n"
+ .' "attemptInterval": 30,'."\n"
+ .' "cleanMode": "{\\"cleanMode\\":\\"NUM_ONLY\\",\\"totalRemain\\":300}",'."\n"
+ .' "description": "",'."\n"
+ .' "routeStrategy": 1,'."\n"
+ .' "userName": "1827811800526502",'."\n"
+ .' "userId": "1827811800526502",'."\n"
+ .' "content": "{\\"jobHandler\\":\\"helloworld\\"}",'."\n"
+ .' "maxConcurrency": 1,'."\n"
+ .' "maxAttempt": 0,'."\n"
+ .' "name": "Specified IP test",'."\n"
+ .' "xattrs": "",'."\n"
+ .' "jobType": "xxljob",'."\n"
+ .' "contentType": 1,'."\n"
+ .' "parameters": "123",'."\n"
+ .' "timeConfig": {'."\n"
+ .' "dataOffset": 0,'."\n"
+ .' "timeType": 1,'."\n"
+ .' "paramMap": {'."\n"
+ .' '."\n"
+ .' },'."\n"
+ .' "timeExpression": "0 * * * * ?"'."\n"
+ .' },'."\n"
+ .' "contactInfoList": ['."\n"
+ .' {'."\n"
+ .' "name": "xiaoming",'."\n"
+ .' "contactType": 1'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "status": 1'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"],
],
- [
- 'name' => 'MaxAttempt',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '错误最大重试次数，根据业务需求填写',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- 'default' => '0',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- 'name' => 'AttemptInterval',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '错误重试间隔，单位s，默认值为30。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- 'default' => '30',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
- [
- 'name' => 'JobHandler',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'jobhandler名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testJobVoidHandler',
- ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- 'name' => 'Script',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '非BEAN任务类型，通过该字段传脚本内容',
- 'description' => '非BEAN任务类型，通过该字段传脚本内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'echo "hello world"',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
- [
- 'name' => 'TimeType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时间类型：'."\n"
- .'- -1: none<br/>'."\n"
- .'- 1：cron<br/>'."\n"
- .'- 3：fix_rate<br/>'."\n"
- .'- 5：one_time<br/>'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '-1',
- 'enum' => [
- '-1',
- '1',
- '2',
- '3',
- '5',
- '100',
- ],
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
- [
- 'name' => 'TimeExpression',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
- .'- **none**：无需填写'."\n"
- .'- **cron**：填写标准的cron表达式，支持在线验证。'."\n"
- .'- **api**：无需填写'."\n"
- .'- **fixed_rate**：填写具体固定频率值，单位s。如200表示每隔200s触发一次。'."\n"
- .'- **one_time**: 填写调度时间（yyyy-MM-dd HH:mm:ss）或者时间戳（毫秒），比如"2022-10-10 10:10:00"',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0 0 4 ? * Mon/1',
- 'enum' => [],
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"\\"{\\\\n \\\\\\"kind\\\\\\": \\\\\\"SchedulerXJobs\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"JSON\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"2.0\\\\\\",\\\\n \\\\\\"content\\\\\\": [\\\\n {\\\\n \\\\\\"appName\\\\\\": \\\\\\"test-app\\\\\\",\\\\n \\\\\\"groupId\\\\\\": \\\\\\"test-app\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"Test App\\\\\\",\\\\n \\\\\\"jobConfigInfo\\\\\\": [\\\\n {\\\\n \\\\\\"jobHandler\\\\\\": \\\\\\"jobDemoHandler\\\\\\",\\\\n \\\\\\"dataOffset\\\\\\": 0,\\\\n \\\\\\"executeMode\\\\\\": \\\\\\"standalone\\\\\\",\\\\n \\\\\\"monitorConfigInfo\\\\\\": {\\\\n \\\\\\"alarmType\\\\\\": \\\\\\"CustomContacts\\\\\\",\\\\n \\\\\\"failLimitTimes\\\\\\": 1,\\\\n \\\\\\"failEnable\\\\\\": true,\\\\n \\\\\\"failRate\\\\\\": 100,\\\\n \\\\\\"timeoutKillEnable\\\\\\": false,\\\\n \\\\\\"missWorkerEnable\\\\\\": false,\\\\n \\\\\\"sendChannel\\\\\\": \\\\\\"webhook,mail\\\\\\",\\\\n \\\\\\"timeoutEnable\\\\\\": true,\\\\n \\\\\\"timeout\\\\\\": 300,\\\\n \\\\\\"daysOfDeadline\\\\\\": 0,\\\\n \\\\\\"successNotice\\\\\\": false\\\\n },\\\\n \\\\\\"attemptInterval\\\\\\": 30,\\\\n \\\\\\"cleanMode\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"cleanMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NUM_ONLY\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"totalRemain\\\\\\\\\\\\\\":300}\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"routeStrategy\\\\\\": 1,\\\\n \\\\\\"userName\\\\\\": \\\\\\"1827811800526502\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"1827811800526502\\\\\\",\\\\n \\\\\\"content\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"jobHandler\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"helloworld\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"maxConcurrency\\\\\\": 1,\\\\n \\\\\\"maxAttempt\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"Specified IP test\\\\\\",\\\\n \\\\\\"xattrs\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"jobType\\\\\\": \\\\\\"xxljob\\\\\\",\\\\n \\\\\\"contentType\\\\\\": 1,\\\\n \\\\\\"parameters\\\\\\": \\\\\\"123\\\\\\",\\\\n \\\\\\"timeConfig\\\\\\": {\\\\n \\\\\\"dataOffset\\\\\\": 0,\\\\n \\\\\\"timeType\\\\\\": 1,\\\\n \\\\\\"paramMap\\\\\\": {\\\\n \\\\n },\\\\n \\\\\\"timeExpression\\\\\\": \\\\\\"0 * * * * ?\\\\\\"\\\\n },\\\\n \\\\\\"contactInfoList\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"xiaoming\\\\\\",\\\\n \\\\\\"contactType\\\\\\": 1\\\\n }\\\\n ],\\\\n \\\\\\"status\\\\\\": 1\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n}\\\\n\\"","type":"json"}]',
+ 'title' => '批量导出任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportJobs'],
],
+ ],
+ ],
+ 'ExportWorkflows' => [
+ 'summary' => '导出工作流为JSON格式，包含工作流基本信息、工作流内所有节点信息、工作流的DAG依赖关系',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Calendar',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'cron类型可以选择填写自定义日历。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'workday',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227429',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'Timezone',
+ 'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '时区',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GMT+8',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'StartTimeType',
+ 'name' => 'WorkflowId',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '开始时间类型',
- 'description' => '开始时间类型',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '工作流ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
'required' => false,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- ],
],
],
[
- 'name' => 'StartTime',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1701310327000',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
- [
- 'name' => 'Priority',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '优先级:'."\n"
- .'- 1: 低'."\n"
- .'- 5: 中'."\n"
- .'- 10: 高'."\n"
- .'- 15: 非常高',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '5',
- ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => '请求体。', 'type' => 'string', 'format' => 'byte', 'example' => '[{"kind":"SchedulerXWorkflows","type":"JSON","version":"2.0","workflowInfo":{"name":"myWorkflow","description":"","appName":"xuerentest","appType":1,"maxConcurrency":1,"currentExecuteStatus":0,"timeConfig":{"timeType":1,"timeExpression":"0 0 12 * * ?","dataOffset":0}},"nodes":[{"name":"Java1","startTime":-1,"coordinate":{"x":-222.0,"y":40.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld\\"}","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell1","startTime":-1,"coordinate":{"x":102.0,"y":-51.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"Java2","startTime":-1,"coordinate":{"x":390.0,"y":55.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld2\\"}","xattrs":"{\\"executorBlockStrategy\\":1,\\"localParams\\":[]}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell2","startTime":-1,"coordinate":{"x":89.0,"y":161.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world2\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]}],"edges":[{"from":"Java1","to":"shell1"},{"from":"Java1","to":"shell2"},{"from":"Schedulerx-Root","to":"Java1"},{"from":"shell1","to":"Java2"},{"from":"shell2","to":"Java2"}]}]'],
],
- [
- 'name' => 'NoticeConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '报警配置',
- 'description' => '通知配置',
- 'type' => 'object',
- 'properties' => [
- 'TimeoutEnable' => [
- 'description' => '超时报警开关。取值如下：'."\n"
- ."\n"
- .'- **true**：开启'."\n"
- ."\n"
- .'- **false**：关闭',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
- 'Timeout' => [
- 'description' => '超时时间，单位秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '30',
- 'default' => '7200',
- ],
- 'TimeoutKillEnable' => [
- 'description' => '超时终止开关。取值如下：'."\n"
- ."\n"
- .'- **true**：开启超时终止开关。'."\n"
- .'- **false**：关闭超时终止开关。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
- 'SuccessNotice' => [
- 'description' => '成功通知开关。取值如下：'."\n"
- ."\n"
- .'- true：开启。'."\n"
- .'- false：关闭。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'FailEnable' => [
- 'description' => '失败报警开关。取值如下：'."\n"
- ."\n"
- .'- **true**：开启失败报警开关。'."\n"
- .'- **false**：关闭失败报警开关。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
- 'FailLimitTimes' => [
- 'description' => '连续失败次数。'."\n"
- .'> 只有连续失败超过配置次数才会收到报警。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- 'MissWorkerEnable' => [
- 'description' => '是否开启无可用机器报警。'."\n"
- .'- **true**：开启无可用机器报警开关。'."\n"
- .'- **false**：关闭无可用机器报警开关。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'SendChannel' => [
- 'description' => '通知渠道,取值如下：'."\n"
- .' - 短信：sms'."\n"
- .' - 电话：phone'."\n"
- .'- 邮件：mail'."\n"
- .'- webhook：webhook'."\n"
- .'> 配置多个通知渠道请用逗号分割',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mail',
- ],
- 'EndEarlyEnable' => [
- 'title' => '提前结束告警开关',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'false',
- ],
- 'EndEarly' => [
- 'title' => '提前结束阈值，单位秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
- ],
- 'required' => false,
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- 'name' => 'NoticeContacts',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '通知联系人配置',
- 'type' => 'array',
- 'items' => [
- 'description' => '.',
- 'type' => 'object',
- 'properties' => [
- 'ContactType' => [
- 'description' => '联系人类型'."\n"
- .'>默认配置: 1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- ],
- ],
- 'Name' => [
- 'description' => '联系人名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xiaoming',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
- [
- 'name' => 'ExecutorBlockStrategy',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户端阻塞处理策略。'."\n"
- .'- 1: 单机串行'."\n"
- .'- 2: 忽略后续调度'."\n"
- .'- 3: 覆盖之前调度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- ],
- ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务状态，默认为启用状态。'."\n"
- .'- 0: 禁用'."\n"
- .'- 1: 启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- ],
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
- [
- 'name' => 'ChildJobId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '子任务id，多个id以逗号分隔',
- 'description' => '子任务id，多个id以逗号分隔',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出工作流',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"\\"[{\\\\\\"kind\\\\\\":\\\\\\"SchedulerXWorkflows\\\\\\",\\\\\\"type\\\\\\":\\\\\\"JSON\\\\\\",\\\\\\"version\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"workflowInfo\\\\\\":{\\\\\\"name\\\\\\":\\\\\\"myWorkflow\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"appType\\\\\\":1,\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"currentExecuteStatus\\\\\\":0,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"timeExpression\\\\\\":\\\\\\"0 0 12 * * ?\\\\\\",\\\\\\"dataOffset\\\\\\":0}},\\\\\\"nodes\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"Java1\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":-222.0,\\\\\\"y\\\\\\":40.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"xxljob\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":1,\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"jobHandler\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"helloworld\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]},{\\\\\\"name\\\\\\":\\\\\\"shell1\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":102.0,\\\\\\"y\\\\\\":-51.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"script_shell\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":2,\\\\\\"content\\\\\\":\\\\\\"echo \\\\\\\\\\\\\\"hello world\\\\\\\\\\\\\\"\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]},{\\\\\\"name\\\\\\":\\\\\\"Java2\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":390.0,\\\\\\"y\\\\\\":55.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"xxljob\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":1,\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"jobHandler\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"helloworld2\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"localParams\\\\\\\\\\\\\\":[]}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]},{\\\\\\"name\\\\\\":\\\\\\"shell2\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":89.0,\\\\\\"y\\\\\\":161.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"script_shell\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":2,\\\\\\"content\\\\\\":\\\\\\"echo \\\\\\\\\\\\\\"hello world2\\\\\\\\\\\\\\"\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]}],\\\\\\"edges\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"Java1\\\\\\",\\\\\\"to\\\\\\":\\\\\\"shell1\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"Java1\\\\\\",\\\\\\"to\\\\\\":\\\\\\"shell2\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"Schedulerx-Root\\\\\\",\\\\\\"to\\\\\\":\\\\\\"Java1\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"shell1\\\\\\",\\\\\\"to\\\\\\":\\\\\\"Java2\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"shell2\\\\\\",\\\\\\"to\\\\\\":\\\\\\"Java2\\\\\\"}]}]\\"","type":"json"}]',
+ ],
+ 'GetApp' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Weight',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务权重',
- 'description' => '任务权重',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227431',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
+ ],
+ 'parameters' => [
[
- 'name' => 'DependentStrategy',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '依赖策略',
- 'description' => '依赖策略',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- ],
- ],
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
[
- 'name' => 'Coordinate',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '节点在工作流中的坐标',
- 'description' => '节点在工作流中的坐标',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'title' => 'X坐标',
- 'description' => 'X坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '100.0',
- ],
- 'Y' => [
- 'title' => 'Y坐标',
- 'description' => 'Y坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '100.0',
- ],
- 'Width' => [
- 'title' => '宽度',
- 'description' => '宽度',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '100.0',
- ],
- 'Height' => [
- 'title' => '高度',
- 'description' => '高度',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '50.0',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Not found: appName not found.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
+ 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '-',
'type' => 'object',
'properties' => [
- 'JobId' => [
- 'description' => '任务id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '74',
- ],
+ 'Id' => ['description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3402'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ 'AccessToken' => ['description' => 'AccessToken。', 'type' => 'string', 'example' => '2f4ddeab8e344ed68e0402cf9b8502ffv3'],
+ 'Title' => ['description' => '标题。', 'type' => 'string', 'example' => '测试应用'],
+ 'Creator' => ['description' => '创建人。', 'type' => 'string', 'example' => '18582193685027xx'],
+ 'Updater' => ['description' => '更新人。', 'type' => 'string', 'example' => '18582193685027xx'],
+ 'Leader' => ['description' => 'Leader地址。', 'type' => 'string', 'example' => 'http://28.***.***.3:80'."\n"],
+ 'MaxJobs' => ['description' => '最大任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'MaxConcurrency' => ['description' => '最大并发数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'JobNum' => ['description' => '任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'ExecutorNum' => ['description' => '执行器数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'EnableLog' => ['description' => '是否开启日志。'."\n"
+ ."\n"
+ .'- true：开启。'."\n"
+ ."\n"
+ .'- false：关闭。', 'type' => 'boolean', 'example' => 'true'],
+ 'LabelRouteStrategy' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'AppType' => ['title' => '应用类型', 'description' => '应用类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": 74\\n }\\n}","type":"json"}]',
- 'title' => '创建任务',
- ],
- 'UpdateJob' => [
- 'summary' => '更新任务信息。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取指定应用',
+ 'summary' => '获取指定应用。',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Not found: appName not found.\\",\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Id\\": 3402,\\n \\"AppName\\": \\"test-app\\",\\n \\"AccessToken\\": \\"2f4ddeab8e344ed68e0402cf9b8502ffv3\\",\\n \\"Title\\": \\"测试应用\\",\\n \\"Creator\\": \\"18582193685027xx\\",\\n \\"Updater\\": \\"18582193685027xx\\",\\n \\"Leader\\": \\"http://28.***.***.3:80\\\\n\\",\\n \\"MaxJobs\\": 1000,\\n \\"MaxConcurrency\\": 100,\\n \\"JobNum\\": 100,\\n \\"ExecutorNum\\": 2,\\n \\"EnableLog\\": true,\\n \\"LabelRouteStrategy\\": 0,\\n \\"AppType\\": 1\\n }\\n}","type":"json"}]',
+ ],
+ 'GetCalendar' => [
+ 'summary' => '获取日历',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227432',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
+ 'abilityTreeCode' => '251680',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '74',
- ],
+ 'name' => 'CalendarName',
+ 'in' => 'query',
+ 'schema' => ['description' => '日历名称', 'type' => 'string', 'required' => true, 'example' => 'workday'],
],
[
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'test-job'."\n",
- 'maxLength' => 200,
- ],
+ 'name' => 'Year',
+ 'in' => 'query',
+ 'schema' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
],
- [
- 'name' => 'Description',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '任务描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test'."\n",
- 'maxLength' => 300,
+ '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' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'CalendarName' => ['description' => '日历名称', 'type' => 'string', 'example' => 'workday'],
+ 'Year' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'example' => '2030'],
+ 'Months' => ['description' => '月。', 'type' => 'string', 'example' => '['."\n"
+ .' {"month":1,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
+ .' {"month":2,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
+ .' {"month":3,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},'."\n"
+ .' {"month":4,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},'."\n"
+ .' {"month":5,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},'."\n"
+ .' {"month":6,"days":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},'."\n"
+ .' {"month":7,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},'."\n"
+ .' {"month":8,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},'."\n"
+ .' {"month":9,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},'."\n"
+ .' {"month":10,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
+ .' {"month":11,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
+ .' {"month":12,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}'."\n"
+ .']'],
+ ],
+ ],
+ ],
],
],
- [
- 'name' => 'RouteStrategy',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '路由策略：'."\n"
- ."\n"
- .'- 1: 轮询'."\n"
- .'- 2: 随机'."\n"
- .'- 3: 第一个'."\n"
- .'- 4: 最后一个'."\n"
- .'- 5: 最不经常使用'."\n"
- .'- 6: 最近最久未使用'."\n"
- .'- 7: 一致性哈希'."\n"
- .'- 8: 分片广播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '9',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- 'name' => 'Parameters',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test'."\n",
- 'maxLength' => 2000,
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
- [
- 'name' => 'MaxConcurrency',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务并发数'."\n"
- .'>同一个任务同一时间允许运行的最大实例个数，1表示不允许重复执行。如果超过并发数，会跳过当前调度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- 'name' => 'MaxAttempt',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务失败重试次数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
- [
- 'name' => 'AttemptInterval',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务失败重试间隔',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CalendarName\\": \\"workday\\",\\n \\"Year\\": 2030,\\n \\"Months\\": \\"[\\\\n {\\\\\\"month\\\\\\":1,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":2,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":3,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},\\\\n {\\\\\\"month\\\\\\":4,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},\\\\n {\\\\\\"month\\\\\\":5,\\\\\\"days\\\\\\":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},\\\\n {\\\\\\"month\\\\\\":6,\\\\\\"days\\\\\\":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},\\\\n {\\\\\\"month\\\\\\":7,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":8,\\\\\\"days\\\\\\":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},\\\\n {\\\\\\"month\\\\\\":9,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},\\\\n {\\\\\\"month\\\\\\":10,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":11,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":12,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}\\\\n]\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取日历',
+ 'changeSet' => [],
+ ],
+ 'GetCluster' => [
+ 'summary' => '获取集群详细信息。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'JobHandler',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'jobhandler名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testJobVoidHandler'."\n",
- 'maxLength' => 200,
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '232722',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
+ ],
+ 'parameters' => [
[
- 'name' => 'Script',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '非BEAN任务，通过该字段配置脚本',
- 'description' => '非BEAN任务，通过该字段配置脚本',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'echo "hello world"',
- ],
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
- [
- 'name' => 'TimeType',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '时间类型，目前支持以下几种类型：'."\n"
- ."\n"
- .'- -1: none'."\n"
- .'- 1：cron'."\n"
- .'- 3：fix_rate'."\n"
- .'- 5：one_time'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '1',
- 'enum' => [
- '-1',
- '1',
- '2',
- '3',
- '5',
- '100',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'xxljob-e0d018c6df8'],
+ 'ClusterName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'xxl-job-test-1730427575152'],
+ 'ClusterSpec' => ['description' => '集群规格，可选规格如下：'."\n"
+ .'- scx.dev.x1。'."\n"
+ .'- scx.small.x1。'."\n"
+ .'- scx.small.x2。'."\n"
+ .'- scx.medium.x1。'."\n"
+ .'- scx.medium.x2。', 'type' => 'string', 'example' => 'scx.small.x2'],
+ 'ProductType' => ['description' => '产品版本。'."\n"
+ ."\n"
+ .'- 1：开发版。'."\n"
+ ."\n"
+ .'- 2：专业版。'."\n"
+ ."\n"
+ .'- 3：企业版。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'EngineType' => ['description' => '引擎类型，可选类型：xxljob。', 'type' => 'string', 'example' => 'xxljob'],
+ 'EngineVersion' => ['description' => '引擎版本。', 'type' => 'string', 'example' => '2.0.0'],
+ 'Status' => ['description' => '集群状态。'."\n"
+ ."\n"
+ .'- 1：创建中。'."\n"
+ .'- 2：运行中。'."\n"
+ .'- 3：重启中。'."\n"
+ .'- 4：销毁中。'."\n"
+ .'- 5：创建失败。'."\n"
+ .'- 6：停机。'."\n"
+ .'- 99：删除。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-10-29 15:56:36'],
+ 'EndTime' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2024-10-29 15:56:36'],
+ 'IntranetDomain' => ['description' => '内网域名。', 'type' => 'string', 'example' => 'http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com'],
+ 'InternetDomain' => ['description' => '公网域名。'."\n"
+ .'> 暂不支持', 'type' => 'string', 'example' => '暂无'],
+ 'ChargeType' => ['description' => '付费方式。 取值说明：'."\n"
+ .'- PREPAY：包年包月。'."\n"
+ .'- POSTPAY：按量付费。', 'type' => 'string', 'example' => 'POSTPAY'],
+ 'KubeConfig' => ['description' => 'K8s服务器的配置信息。', 'type' => 'string', 'example' => '{'."\n"
+ .' "vSwitchIdList": ['."\n"
+ .' "xxx",'."\n"
+ .' "xxx"'."\n"
+ .' ],'."\n"
+ .' "cpu": xxx,'."\n"
+ .' "cpuUnit": "xxx",'."\n"
+ .' "diskCapacity": xxx,'."\n"
+ .' "memoryCapacity": xxx,'."\n"
+ .' "zoneIds": ['."\n"
+ .' "xxx",'."\n"
+ .' "xxx"'."\n"
+ .' ],'."\n"
+ .' "securityGroupList": ['."\n"
+ .' "xxx"'."\n"
+ .' ],'."\n"
+ .' "eniCrossZone": "xxx",'."\n"
+ .' "regionId": "xxx",'."\n"
+ .' "instanceCount": xxx,'."\n"
+ .' "vpcId": "xxx",'."\n"
+ .' "memoryUnit": "xxx",'."\n"
+ .' "diskType": "xxx",'."\n"
+ .' "appClusterId": "xxx"'."\n"
+ .'}'."\n"],
+ 'JobNum' => ['description' => '该规格下最大任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'WorkerNum' => ['description' => '执行器数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'VSwitches' => [
+ 'description' => '可用区交换机信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-k'],
+ 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-8vbf1n216nshvfjdyff8a'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1fiz967u39lt8yuxcs0'],
+ 'MaxJobNum' => ['description' => '该规格下最大任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'Spm' => ['description' => '每分钟调度峰值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Zones' => [
+ 'description' => '可用区列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-i'],
+ ],
+ 'VersionLifecycle' => ['type' => 'string', 'description' => ''],
+ 'MaxWorkflowNum' => ['title' => '最大支持的工作流个数', 'description' => '最大支持的工作流个数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'WorkflowNum' => ['title' => '当前工作流个数', 'description' => '当前工作流个数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'IpWhitelist' => ['title' => 'ip白名单，多个以英文逗号分隔', 'type' => 'string', 'example' => '192.168.1.0/24'],
+ 'Tags' => ['type' => 'object', 'description' => ''],
+ 'ClusterType' => ['title' => '集群类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Source' => ['title' => '来源', 'type' => 'string'],
+ ],
+ 'description' => '',
+ ],
],
],
],
- [
- 'name' => 'TimeExpression',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
- ."\n"
- .'- none：无需填写'."\n"
- .'- cron：填写标准的cron表达式，支持在线验证。'."\n"
- .'- api：无需填写'."\n"
- .'- fixed_rate：填写具体固定频率值，单位s。如30表示每隔30s触发一次。'."\n"
- .'- one_time: 填写调度时间（yyyy-MM-dd HH:mm:ss）或者时间戳（毫秒），比如"2022-10-10 10:10:00"',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0 0 4 ? * Mon/1'."\n",
- ],
- ],
- [
- 'name' => 'Calendar',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '自定义日历',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'workday',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- 'name' => 'Priority',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务执行优先级。目前支持以下几种配置：'."\n"
- ."\n"
- .'- 1: 低'."\n"
- .'- 5: 中'."\n"
- .'- 10: 高'."\n"
- .'- 15: 非常高',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '10',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
- [
- 'name' => 'StartTimeType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间类型',
- 'description' => '开始时间类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- ],
- ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- 'name' => 'StartTime',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '调度开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1716902187',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
- [
- 'name' => 'Timezone',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时区'."\n"
- .'> 默认使用schedulerx服务器所在时区',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Hongkong',
- ],
- ],
- [
- 'name' => 'NoticeConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '报警配置',
- 'description' => '通知配置',
- 'type' => 'object',
- 'properties' => [
- 'TimeoutEnable' => [
- 'description' => '超时报警开关。取值如下：'."\n"
- ."\n"
- .'- true：开启'."\n"
- ."\n"
- .'- false：关闭',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Timeout' => [
- 'description' => '任务执行超时时间，单位为秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '90',
- ],
- 'TimeoutKillEnable' => [
- 'description' => '超时终止本次触发开关。取值如下：'."\n"
- ."\n"
- .'- **true**：开启超时终止开关。'."\n"
- .'- **false**：关闭超时终止开关。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'SuccessNotice' => [
- 'description' => '成功通知开关。取值如下：'."\n"
- ."\n"
- .'- true：开启。'."\n"
- .'- false：关闭。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'FailEnable' => [
- 'description' => '失败报警开关。取值如下：'."\n"
- ."\n"
- .'- **true**：开启失败报警开关。'."\n"
- .'- **false**：关闭失败报警开关。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'FailLimitTimes' => [
- 'description' => '连续失败次数。'."\n"
- .'> 只有连续失败超过配置次数才会收到报警。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'true',
- 'default' => '1',
- ],
- 'MissWorkerEnable' => [
- 'description' => '是否开启无可用机器告警。'."\n"
- .'- **true**：开启无可用机器告警开关。'."\n"
- .'- **false**：关闭无可用机器告警开关。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'SendChannel' => [
- 'description' => '通知渠道,取值如下：'."\n"
- .' - 短信：sms'."\n"
- .' - 电话：phone'."\n"
- .'- 邮件：mail'."\n"
- .'- webhook：webhook'."\n"
- .'> 配置多个通知渠道请用逗号分割',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'webhook,sms,mail,phone'."\n",
- ],
- 'EndEarlyEnable' => [
- 'title' => '提前结束报警开关',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'false',
- ],
- 'EndEarly' => [
- 'title' => '提前结束的阈值，单位秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
- ],
- 'required' => false,
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
- [
- 'name' => 'NoticeContacts',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '通知联系人配置',
- 'type' => 'array',
- 'items' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'ContactType' => [
- 'description' => '联系人类型 '."\n"
- .'>默认配置: 1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- ],
- ],
- 'Name' => [
- 'description' => '联系人名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xiaoming',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ClusterId\\": \\"xxljob-e0d018c6df8\\",\\n \\"ClusterName\\": \\"xxl-job-test-1730427575152\\",\\n \\"ClusterSpec\\": \\"scx.small.x2\\",\\n \\"ProductType\\": 2,\\n \\"EngineType\\": \\"xxljob\\",\\n \\"EngineVersion\\": \\"2.0.0\\",\\n \\"Status\\": 2,\\n \\"CreateTime\\": \\"2024-10-29 15:56:36\\",\\n \\"EndTime\\": \\"2024-10-29 15:56:36\\",\\n \\"IntranetDomain\\": \\"http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"暂无\\",\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"KubeConfig\\": \\"{\\\\n \\\\\\"vSwitchIdList\\\\\\": [\\\\n \\\\\\"xxx\\\\\\",\\\\n \\\\\\"xxx\\\\\\"\\\\n ],\\\\n \\\\\\"cpu\\\\\\": xxx,\\\\n \\\\\\"cpuUnit\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"diskCapacity\\\\\\": xxx,\\\\n \\\\\\"memoryCapacity\\\\\\": xxx,\\\\n \\\\\\"zoneIds\\\\\\": [\\\\n \\\\\\"xxx\\\\\\",\\\\n \\\\\\"xxx\\\\\\"\\\\n ],\\\\n \\\\\\"securityGroupList\\\\\\": [\\\\n \\\\\\"xxx\\\\\\"\\\\n ],\\\\n \\\\\\"eniCrossZone\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"regionId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"instanceCount\\\\\\": xxx,\\\\n \\\\\\"vpcId\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"memoryUnit\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"diskType\\\\\\": \\\\\\"xxx\\\\\\",\\\\n \\\\\\"appClusterId\\\\\\": \\\\\\"xxx\\\\\\"\\\\n}\\\\n\\",\\n \\"JobNum\\": 100,\\n \\"WorkerNum\\": 10,\\n \\"VSwitches\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"VSwitchId\\": \\"vsw-8vbf1n216nshvfjdyff8a\\"\\n }\\n ],\\n \\"VpcId\\": \\"vpc-bp1fiz967u39lt8yuxcs0\\",\\n \\"MaxJobNum\\": 1000,\\n \\"Spm\\": 10,\\n \\"Zones\\": [\\n \\"cn-hangzhou-i\\"\\n ],\\n \\"VersionLifecycle\\": \\"\\",\\n \\"MaxWorkflowNum\\": 100,\\n \\"WorkflowNum\\": 20,\\n \\"IpWhitelist\\": \\"192.168.1.0/24\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ClusterType\\": 1,\\n \\"Source\\": \\"\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取集群详细信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-04T09:16:51.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-04-29T06:59:52.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCluster'],
],
+ ],
+ ],
+ 'GetDesigateInfo' => [
+ 'summary' => '获取指定机器信息。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ExecutorBlockStrategy',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户端阻塞处理策略。'."\n"
- .'- 1: 单机串行'."\n"
- .'- 2: 忽略后续调度'."\n"
- .'- 3: 覆盖之前调度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- ],
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '251661',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'ChildJobId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '子任务id，多个以逗号分隔',
- 'description' => '子任务id，多个以逗号分隔',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Weight',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务权重',
- 'description' => '任务权重',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'DependentStrategy',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '依赖策略',
- 'description' => '依赖策略',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- ],
- ],
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题',
- 'type' => 'string',
- 'example' => '3808cf26-dde2-4286-8503-b0a2cd4065a7',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'."\n"],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DesignateType' => ['description' => '指定机器的类型。具体取值如下：'."\n"
+ .'- 1：worker。'."\n"
+ .'- 2：label。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Transferable' => ['description' => '是否故障转移。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
],
@@ -4661,150 +2781,91 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3808cf26-dde2-4286-8503-b0a2cd4065a7\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新任务',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DF6732E-15D8-5E1F-95E3-C10077F556B5\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DesignateType\\": 2,\\n \\"Transferable\\": true\\n }\\n}","type":"json"}]',
+ 'title' => '获取指定机器信息',
+ 'changeSet' => [],
],
- 'UpdateJobScript' => [
- 'summary' => '更新任务执行脚本。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetExecutorConfig' => [
+ 'summary' => '获取制定执行器配置信息',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227449',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
+ 'abilityTreeCode' => '227430',
+ 'abilityTreeNodes' => ['FEATUREmseWGXOHM'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'ScriptContent',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '脚本内容。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '#!/bin/bash'."\n"
- .'echo "xxl-job: hello shell"'."\n"
- ."\n"
- .'echo "脚本位置: $0"'."\n"
- .'echo "任务参数: $1"'."\n"
- .'echo "分片序号 = $2"'."\n"
- .'echo "分片总数 = $3"'."\n"
- ."\n"
- .'echo "Good bye!"'."\n"
- .'exit 0',
- ],
- ],
- [
- 'name' => 'VersionDescription',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '脚本版本描述。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'init version',
- ],
- ],
- [
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '74',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'not support update script, please upgrade engine version to 2.2.2+',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF',
- ],
- 'Success' => [
- 'description' => '是否调用成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+'],
+ 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '查询结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Config' => ['description' => '数据集成同步解决方案任务默认的全局配置内容（即对不同DDL消息类型配置的默认处理策略）。示例如下：'."\n"
+ .'{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'."\n"
+ ."\n"
+ .'DDL消息类型如下：'."\n"
+ .'- RENAMECOLUMN：重命名列。'."\n"
+ .'- DROPTABLE：删除表。'."\n"
+ .'- CREATETABLE：新建表。'."\n"
+ .'- MODIFYCOLUMN：修改列类型。'."\n"
+ .'- TRUNCATETABLE：清空表。'."\n"
+ .'- DROPCOLUMN：删除列。'."\n"
+ .'- ADDCOLUMN：新增列。'."\n"
+ .'- RENAMETABLE：重命名表。'."\n"
+ ."\n"
+ .'DataWorks收到对应类型的DDL消息时，处理策略如下：'."\n"
+ .'- WARNING：直接丢弃该消息，同时会在实时同步日志中记录告警信息，指明该消息因执行出错被丢弃。'."\n"
+ .'- IGNORE：直接丢弃该消息，不再向目的端数据源发送。'."\n"
+ .'- CRITICAL：实时同步任务直接显示出错状态并终止运行。'."\n"
+ .'- NORMAL：将相应消息继续下发给目的端数据源，由目的端数据源来处理。因为不同目的端数据源对DDL消息处理策略可能会不同，因此DataWorks只执行转发操作。'."\n", 'type' => 'string', 'example' => '[{"cluster":"c2c619b5129e0400fa3df263b249622aa","namespace":"default","service":"xxljob-http-demo1-svc"}]'],
+ 'ExecutorType' => ['description' => '执行器类型', 'type' => 'string', 'example' => 'k8s_service'],
+ ],
],
],
],
@@ -4812,131 +2873,141 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"not support update script, please upgrade engine version to 2.2.2+\\",\\n \\"RequestId\\": \\"29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新任务执行脚本',
- ],
- 'DeleteJobs' => [
- 'summary' => '批量删除任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Config\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"c2c619b5129e0400fa3df263b249622aa\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"default\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxljob-http-demo1-svc\\\\\\"}]\\",\\n \\"ExecutorType\\": \\"k8s_service\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取制定执行器配置信息',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ ],
+ 'GetJobExecution' => [
+ 'summary' => '获取任务执行的详细信息。',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227449',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeNodes' => ['FEATUREmseWGXOHM'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'JobIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '74',
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'JobExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行ID', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120'],
+ ],
+ [
+ 'name' => 'MseSessionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '91143E1D-E235-5BE0-9364-C2EE28FFB5A6',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobExecutionId' => ['description' => '任务执行ID', 'type' => 'string', 'example' => '1310630367761285120'],
+ 'JobId' => ['description' => '任务id', 'type' => 'integer', 'format' => 'int64', 'example' => '74'],
+ 'JobName' => ['description' => '任务名称', 'type' => 'string', 'example' => '天猫-自动审单'],
+ 'JobType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'xxljob'],
+ 'Parameters' => ['description' => '任务参数。', 'type' => 'string', 'example' => '/home/avatar/system/services/biz/payment/crontab/monitorpayment.php'],
+ 'ScheduleTime' => ['description' => '任务调度时间。', 'type' => 'string', 'example' => '2025-03-11 00:06:10'],
+ 'DataTime' => ['description' => '任务数据时间。', 'type' => 'string', 'example' => '2025-03-11 00:06:10'],
+ 'StartTime' => ['description' => '部署任务执行开始时间（秒，时间戳格式）。', 'type' => 'string', 'example' => '2025-03-11 00:06:10'],
+ 'EndTime' => ['description' => '过期时间', 'type' => 'string', 'example' => '2024-10-29 15:56:36'],
+ 'Duration' => ['description' => '运行总时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Executor' => ['description' => '执行者ID。', 'type' => 'string', 'example' => '{\'Status\': \'NORMAL\', \'ActiveCount\': 4, \'UnavailableCount\': 0, \'ExpectedCount\': 4, \'RiskCount\': 0}'],
+ 'Result' => ['description' => '返回结果。', 'type' => 'string', 'example' => '[]'],
+ 'Status' => ['description' => '任务执行状态。具体说明如下：'."\n"
+ .'- 0: UNKNOWN (未知)。'."\n"
+ .'- 1: WAITING (等待)。'."\n"
+ .'- 2: READY (准备就绪)。'."\n"
+ .'- 3: RUNNING (运行中)。'."\n"
+ .'- 4: SUCCESS (成功)。'."\n"
+ .'- 5: FAILED (失败)。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'TimeType' => ['description' => '时间类型：'."\n"
+ .'- -1: none'."\n"
+ .'- 1：cron'."\n"
+ .'- 2: fixed_delay'."\n"
+ .'- 3：fixed_rate'."\n"
+ .'- 5：one_time'."\n"
+ .'- 100:：api', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Attempt' => ['description' => '失败尝试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ 'RouteStrategy' => ['description' => '路由策略。具体取值如下：'."\n"
+ .'- 1: 轮询'."\n"
+ .'- 2: 随机'."\n"
+ .'- 3: 第一个'."\n"
+ .'- 4: 最后一个'."\n"
+ .'- 5: 最不经常使用'."\n"
+ .'- 6: 最近最久未使用'."\n"
+ .'- 7: 一致性哈希'."\n"
+ .'- 8: 分片广播', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ServerIp' => ['description' => '调度节点。', 'type' => 'string', 'example' => '172.3.27.76'],
+ 'TriggerType' => ['description' => '任务触发类型。具体说明如下：'."\n"
+ .'- 0：unknown。'."\n"
+ .'- 1：timer_schedule。'."\n"
+ .'- 2：rerun。'."\n"
+ .'- 3：api_run。'."\n"
+ .'- 4：user_retry。'."\n"
+ .'- 5：system_retry。'."\n"
+ .'- 6：manual。', 'type' => 'integer', 'format' => 'int32', 'example' => 'timer_schedule'],
+ ],
],
],
],
@@ -4944,129 +3015,167 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"91143E1D-E235-5BE0-9364-C2EE28FFB5A6\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '批量删除任务',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobExecutionId\\": \\"1310630367761285120\\",\\n \\"JobId\\": 74,\\n \\"JobName\\": \\"天猫-自动审单\\",\\n \\"JobType\\": \\"xxljob\\",\\n \\"Parameters\\": \\"/home/avatar/system/services/biz/payment/crontab/monitorpayment.php\\",\\n \\"ScheduleTime\\": \\"2025-03-11 00:06:10\\",\\n \\"DataTime\\": \\"2025-03-11 00:06:10\\",\\n \\"StartTime\\": \\"2025-03-11 00:06:10\\",\\n \\"EndTime\\": \\"2024-10-29 15:56:36\\",\\n \\"Duration\\": 1,\\n \\"Executor\\": \\"{\'Status\': \'NORMAL\', \'ActiveCount\': 4, \'UnavailableCount\': 0, \'ExpectedCount\': 4, \'RiskCount\': 0}\\",\\n \\"Result\\": \\"[]\\",\\n \\"Status\\": 4,\\n \\"TimeType\\": 1,\\n \\"Attempt\\": 1,\\n \\"AppName\\": \\"test-app\\",\\n \\"RouteStrategy\\": 1,\\n \\"ServerIp\\": \\"172.3.27.76\\",\\n \\"TriggerType\\": 0\\n }\\n}","type":"json"}]',
+ 'title' => '获取任务执行的详细信息',
+ 'changeSet' => [],
],
- 'OperateEnableJobs' => [
- 'summary' => '批量启用任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetJobExecutionProgress' => [
+ 'summary' => '获取分片任务执行的详情。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227450',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '227428',
+ 'abilityTreeNodes' => ['FEATUREmseWGXOHM'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'JobIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '74',
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'JobExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '4CC4132F-B798-5D6E-9F06-D44B33E417E9',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '9B57FDD7-ABBE-5030-B348-86EB9943DB59'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter format error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobDescription' => ['description' => '任务描述。', 'type' => 'string', 'example' => '测试任务'],
+ 'TotalProgress' => [
+ 'description' => '任务整体进度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Total' => ['description' => '总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
+ 'Finished' => ['description' => '完成的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
+ ],
+ ],
+ 'RootProgress' => [
+ 'description' => '根任务进度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Total' => ['description' => '总数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'Finished' => ['description' => '完成的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
+ ],
+ 'TaskProgress' => [
+ 'description' => '子任务进度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '子任务进度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'calendar_test_2'],
+ 'Total' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'Pulled' => ['description' => '已拉取数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Queue' => ['description' => '队列中数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Running' => ['description' => '运行中数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Success' => ['description' => '成功的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Failed' => ['description' => '已失败数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ ],
+ ],
+ 'ShardingProgress' => [
+ 'description' => '分片任务进度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '分片任务进度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'WorkerAddr' => ['description' => '机器地址。', 'type' => 'string', 'example' => 'http://192.168.***.9:9999/'],
+ 'Status' => ['description' => '任务执行状态。具体说明如下：'."\n"
+ .'- 0：unknown。'."\n"
+ .'- 1：init。'."\n"
+ .'- 2：pulled。'."\n"
+ .'- 3：running。'."\n"
+ .'- 4：success。'."\n"
+ .'- 5：failed。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'StatusType' => [
+ 'description' => '状态类型。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '任务状态码。', 'type' => 'string', 'example' => '5'],
+ 'Name' => ['description' => '状态名称', 'type' => 'string', 'example' => 'TaskStatus.FAILED'],
+ 'Tips' => [
+ 'description' => '提示信息。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => 'Task execution failed', 'description' => '提示信息。'],
+ ],
+ ],
+ ],
+ 'JobExecutionId' => ['description' => '分片执行ID。', 'type' => 'string', 'example' => '1306189481388277762'],
+ 'Result' => ['description' => '分片执行结果。', 'type' => 'string', 'example' => '2,4,6,8,10'],
+ ],
+ ],
+ ],
+ 'WorkerProgress' => [
+ 'description' => '机器维度执行进度。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '机器维度执行进度。',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkerAddr' => ['description' => '机器地址。', 'type' => 'string', 'example' => '10.***.***.53:61941'."\n"],
+ 'Total' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Pulled' => ['description' => '已拉取数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Queue' => ['description' => '队列中数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Running' => ['description' => '运行中数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Success' => ['description' => '成功的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Failed' => ['description' => '已失败数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TraceId' => ['description' => '全链路ID。', 'type' => 'string', 'example' => '1a0e97fb17244665327205402dbd6d'],
+ ],
+ ],
+ ],
+ 'StartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'example' => '1758506761000'],
+ 'EndTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'example' => '1758594961000'],
+ ],
],
],
],
@@ -5074,130 +3183,99 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"4CC4132F-B798-5D6E-9F06-D44B33E417E9\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '批量启用任务',
- ],
- 'OperateDisableJobs' => [
- 'summary' => '批量禁用任务。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"9B57FDD7-ABBE-5030-B348-86EB9943DB59\\",\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobDescription\\": \\"测试任务\\",\\n \\"TotalProgress\\": {\\n \\"Total\\": 30,\\n \\"Finished\\": 15\\n },\\n \\"RootProgress\\": {\\n \\"Total\\": 2,\\n \\"Finished\\": 2\\n },\\n \\"TaskProgress\\": [\\n {\\n \\"Name\\": \\"calendar_test_2\\",\\n \\"Total\\": 1000,\\n \\"Pulled\\": 10,\\n \\"Queue\\": 100,\\n \\"Running\\": 1,\\n \\"Success\\": 100,\\n \\"Failed\\": 100\\n }\\n ],\\n \\"ShardingProgress\\": [\\n {\\n \\"Id\\": 1,\\n \\"WorkerAddr\\": \\"http://192.168.***.9:9999/\\",\\n \\"Status\\": 5,\\n \\"StatusType\\": {\\n \\"Code\\": \\"5\\",\\n \\"Name\\": \\"TaskStatus.FAILED\\",\\n \\"Tips\\": {\\n \\"key\\": \\"Task execution failed\\"\\n }\\n },\\n \\"JobExecutionId\\": \\"1306189481388277762\\",\\n \\"Result\\": \\"2,4,6,8,10\\"\\n }\\n ],\\n \\"WorkerProgress\\": [\\n {\\n \\"WorkerAddr\\": \\"10.***.***.53:61941\\\\n\\",\\n \\"Total\\": 100,\\n \\"Pulled\\": 20,\\n \\"Queue\\": 20,\\n \\"Running\\": 20,\\n \\"Success\\": 20,\\n \\"Failed\\": 20,\\n \\"TraceId\\": \\"1a0e97fb17244665327205402dbd6d\\"\\n }\\n ],\\n \\"StartTime\\": \\"1758506761000\\",\\n \\"EndTime\\": \\"1758594961000\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取分片任务执行的详情',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobExecutionProgress'],
+ ],
],
+ ],
+ 'GetJobExecutionThreadDump' => [
+ 'summary' => '查询任务执行堆栈。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227445',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '260227',
+ 'abilityTreeNodes' => ['FEATUREmseWJZKU4'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'xxl-job-executor-sample'],
],
[
- 'name' => 'JobIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '74',
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'JobExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
+ ],
+ [
+ 'name' => 'ExecutorAddr',
+ 'in' => 'query',
+ 'schema' => ['description' => '执行器地址。', 'type' => 'string', 'required' => false, 'example' => 'http://192.168.0.215:9966/'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'Parameter error: appId is null.'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'Dump' => ['description' => '堆栈信息', 'type' => 'string', 'example' => '\\"Thread-7\\" Id=67 TIMED_WAITING\\n\\tat java.base@17.0.5/java.lang.Thread.sleep(Native Method)\\n\\tat app//com.xxl.job.executor.service.jobhandler.SampleXxlJob.shardingJobHandler(SampleXxlJob.java:73)\\n\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\\n\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)\\n\\tat java.base@17.0.5/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\\n\\tat java.base@17.0.5/java.lang.reflect.Method.invoke(Method.java:568)\\n\\tat app//com.xxl.job.core.handler.impl.MethodJobHandler.execute(MethodJobHandler.java:29)\\n\\tat app//com.xxl.job.core.thread.JobThread.run(JobThread.java:152)\\n'],
+ ],
],
],
],
@@ -5205,128 +3283,131 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '批量禁用任务',
- ],
- 'OperateRerunJob' => [
- 'summary' => '重刷任务历史数据。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: appId is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Dump\\": \\"\\\\\\\\\\\\\\"Thread-7\\\\\\\\\\\\\\" Id=67 TIMED_WAITING\\\\\\\\n\\\\\\\\tat java.base@17.0.5/java.lang.Thread.sleep(Native Method)\\\\\\\\n\\\\\\\\tat app//com.xxl.job.executor.service.jobhandler.SampleXxlJob.shardingJobHandler(SampleXxlJob.java:73)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/java.lang.reflect.Method.invoke(Method.java:568)\\\\\\\\n\\\\\\\\tat app//com.xxl.job.core.handler.impl.MethodJobHandler.execute(MethodJobHandler.java:29)\\\\\\\\n\\\\\\\\tat app//com.xxl.job.core.thread.JobThread.run(JobThread.java:152)\\\\\\\\n\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询任务执行堆栈',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobExecutionThreadDump'],
+ ],
],
+ ],
+ 'GetLog' => [
+ 'summary' => '查询日志。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227442',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '227424',
+ 'abilityTreeNodes' => ['FEATUREmse8C5258'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
],
[
- 'name' => 'JobId',
+ 'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '74',
- ],
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
[
- 'name' => 'StartDate',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1698458024000',
- ],
+ 'schema' => ['description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721636220'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1698458024000',
- ],
+ 'schema' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721636220'],
],
[
- 'name' => 'DataTime',
+ 'name' => 'Level',
'in' => 'query',
'schema' => [
- 'description' => '数据时间。',
+ 'description' => '日志等级。',
'type' => 'string',
- 'required' => true,
- 'example' => '14:11:10',
+ 'required' => false,
+ 'example' => 'INFO',
+ 'enum' => ['INFO', 'ERROR', 'WARN', 'DEBUG'],
],
],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => '搜索关键词。', 'type' => 'string', 'required' => false, 'example' => 'hello word'],
+ ],
+ [
+ 'name' => 'Offset',
+ 'in' => 'query',
+ 'schema' => ['description' => '偏移。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'LineNum',
+ 'in' => 'query',
+ 'schema' => ['description' => 'LineNum。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'Reverse',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否降序：'."\n"
+ ."\n"
+ .' - **true**：按降序排序。'."\n"
+ .' - **false**：按升序排序。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'LogId',
+ 'in' => 'query',
+ 'schema' => ['description' => '日志ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '344008'],
+ ],
+ [
+ 'name' => 'WorkerAddr',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['title' => '执行器地址', 'description' => '执行器地址', 'type' => 'string', 'required' => false, 'example' => '192.168.1.100'],
+ ],
+ [
+ 'name' => 'ScheduleTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '调度时间', 'description' => '调度时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2023-10-01 12:00:00'],
+ ],
],
'responses' => [
200 => [
@@ -5335,29 +3416,20 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'BCDF4006-C8A1-5F83-9368-588347D3EE84',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => ['description' => '日志信息。', 'type' => 'string', 'example' => 'ip : 10.**.***.53:58098'."\n"
+ .'executionId : 74_1310******761285120_0'."\n"
+ .'level : INFO'."\n"
+ .'log : hello word!;'."\n"
+ .'time : 2024-10-31 16:43:51'],
+ 'description' => '',
],
],
],
@@ -5365,205 +3437,149 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Data\\": [\\n \\"ip : 10.**.***.53:58098\\\\nexecutionId : 74_1310******761285120_0\\\\nlevel : INFO\\\\nlog : hello word!;\\\\ntime : 2024-10-31 16:43:51\\"\\n ]\\n}","type":"json"}]',
+ 'title' => '查询日志',
+ 'changeSet' => [
+ ['createdAt' => '2025-10-17T05:41:01.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCDF4006-C8A1-5F83-9368-588347D3EE84\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]',
- 'title' => '重刷任务历史数据',
],
- 'ListJobs' => [
- 'summary' => '获取任务列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetLogEvent' => [
+ 'summary' => '查询事件。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227452',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
+ 'abilityTreeCode' => '228058',
+ 'abilityTreeNodes' => ['FEATUREmse8C5258'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-684d02ee5a6'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'xxl-job-executor-perf-test-241'],
],
[
- 'name' => 'Status',
+ 'name' => 'EventType',
'in' => 'query',
'schema' => [
- 'description' => '状态。',
+ 'title' => '事件类型',
+ 'description' => '事件类型',
'type' => 'string',
'required' => false,
- 'example' => '0',
+ 'example' => 'JOB',
+ 'default' => 'JOB',
+ 'enum' => ['JOB', 'WORKFLOW'],
],
],
[
- 'name' => 'JobId',
+ 'name' => 'JobName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'JobName',
+ 'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'job01',
- ],
+ 'schema' => ['description' => '任务执行ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101'],
],
[
- 'name' => 'Description',
+ 'name' => 'WorkflowName',
'in' => 'query',
- 'schema' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'job01单机任务',
- ],
+ 'schema' => ['title' => '工作流名称', 'description' => '工作流名称', 'type' => 'string', 'required' => false, 'example' => '流程001'],
],
[
- 'name' => 'JobHandler',
+ 'name' => 'WorkflowExecutionId',
+ 'in' => 'query',
+ 'schema' => ['title' => '工作流执行ID', 'description' => '工作流执行ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1450568762586578000'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721268302000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721636220'],
+ ],
+ [
+ 'name' => 'Event',
'in' => 'query',
'schema' => [
- 'description' => '`jobhandler`名称。',
+ 'description' => '事件',
'type' => 'string',
'required' => false,
- 'example' => 'jobDemoHandler',
+ 'example' => 'INFO',
+ 'enum' => [],
],
],
[
- 'name' => 'PageNum',
+ 'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'description' => '页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '关键字', 'type' => 'string', 'required' => false, 'example' => 'test_partition_tbl'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '每页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20'],
],
[
- 'name' => 'WorkflowId',
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'title' => '工作流ID',
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '分页的页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'Reverse',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否降序：'."\n"
+ ."\n"
+ .' - **true**：按降序排序'."\n"
+ .' - **false**：按升序排序', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题',
- 'type' => 'string',
- 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '-',
'type' => 'object',
@@ -5575,264 +3591,23 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'JobId' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '74',
- ],
- 'Name' => [
- 'description' => '任务名。',
- 'type' => 'string',
- 'example' => 'job01',
- ],
- 'Description' => [
- 'description' => '任务描述。',
- 'type' => 'string',
- 'example' => 'job01单机任务',
- ],
- 'JobType' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'example' => 'xxljob',
- ],
- 'Status' => [
- 'description' => '任务状态。具体取值如下：'."\n"
- .'- 0：DISABLE (禁用)。'."\n"
- .'- 1：ENABLE (启用)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Parameters' => [
- 'description' => '任务参数。',
- 'type' => 'string',
- 'example' => 'name=10',
- ],
- 'MaxConcurrency' => [
- 'description' => '总体并发数阈值。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'MaxAttempt' => [
- 'description' => '错误最大重试次数，根据业务需求填写。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'AttemptInterval' => [
- 'description' => '错误重试间隔，单位`s`。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'JobHandler' => [
- 'description' => '`jobhandler`名称。',
- 'type' => 'string',
- 'example' => 'jobDemoHandler',
- ],
- 'Priority' => [
- 'description' => '执行作业优先级。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TimeType' => [
- 'description' => '时间类型，目前支持以下几种类型：'."\n"
- ."\n"
- .'- -1：none。'."\n"
- .'- 1：cron。'."\n"
- .'- 3：fix_rate。'."\n"
- .'- 5：one_time。'."\n"
- .'- 100：api。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TimeExpression' => [
- 'description' => '时间表达式。',
- 'type' => 'string',
- 'example' => '0 0 12 * * ?',
- ],
- 'TimeZone' => [
- 'description' => '时区。',
- 'type' => 'string',
- 'example' => 'Hongkong',
- ],
- 'Calendar' => [
- 'description' => '日历。',
- 'type' => 'string',
- 'example' => 'work-day',
- ],
- 'DataOffset' => [
- 'description' => '数据偏移。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'CleanMode' => [
- 'description' => '清理模式。',
- 'type' => 'string',
- 'example' => '{"cleanMode":"NUM_ONLY","totalRemain":300}',
- ],
- 'Creator' => [
- 'description' => '创建者。',
- 'type' => 'string',
- 'example' => '1963096506470832',
- ],
- 'Updater' => [
- 'description' => '更新者。',
- 'type' => 'string',
- 'example' => '1963096506470832',
- ],
- 'Xattrs' => [
- 'description' => '扩展属性。'."\n"
- .'> 暂不支持',
- 'type' => 'string',
- 'example' => '暂无',
- ],
- 'NoticeConfig' => [
- 'description' => '`Notice`配置。',
- 'type' => 'string',
- 'example' => '{"failLimitTimes":1,"failEnable":true,"timeoutKillEnable":false,"missWorkerEnable":true,"timeoutEnable":true,"sendChannel":"","timeout":300,"successNotice":false}',
- ],
- 'NoticeContacts' => [
- 'description' => '通知联系人。',
- 'type' => 'string',
- 'example' => '[{"contactType":1,"name":"恰橙"}]',
- ],
- 'RouteStrategy' => [
- 'description' => '路由策略：'."\n"
- .'- 1：轮询。'."\n"
- .'- 2：随机。'."\n"
- .'- 3：第一个。'."\n"
- .'- 4：最后一个。'."\n"
- .'- 5：最不经常使用。'."\n"
- .'- 6：最近最久未使用。'."\n"
- .'- 7：一致性哈希。'."\n"
- .'- 8：分片广播。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AppName' => [
- 'description' => '应用名。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'Timezone' => [
- 'description' => '时区。',
- 'type' => 'string',
- 'example' => 'HangKong',
- ],
- 'LastExecuteEndTime' => [
- 'description' => '上一次执行结束时间。',
- 'type' => 'string',
- 'example' => '2025-06-29 15:56:36'."\n",
- ],
- 'LastExecuteStatus' => [
- 'description' => '上一次的执行结果。'."\n"
- .'- 4: 成功'."\n"
- .'- 5: 失败',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'CurrentExecuteStatus' => [
- 'description' => '当前执行状态：'."\n"
- .'- 0：未开始。'."\n"
- .'- 1：运行中。'."\n"
- .'- 2：队列中。'."\n"
- .'- 3：等待中。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- ],
- ],
- 'ChildJobId' => [
- 'description' => '子任务ID。',
- 'type' => 'string',
- 'example' => '1246',
- ],
- 'Weight' => [
- 'title' => '任务权重',
- 'description' => '任务权重。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NodeType' => [
- 'title' => '节点类型',
- 'description' => '节点类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DependentStrategy' => [
- 'title' => '依赖检查策略',
- 'description' => '依赖检查策略',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Script' => [
- 'description' => '脚本内容。',
- 'type' => 'string',
- 'example' => '#!/bin/bash'."\n"
- .'echo "xxl-job: hello shell"'."\n"
- .'echo "Good bye!"'."\n"
- .'exit 0',
- ],
- 'WorkflowId' => [
- 'title' => '工作流ID',
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'ExecutorBlockStrategy' => [
- 'description' => '客户端阻塞处理策略。'."\n"
- .'- 1: 单机串行'."\n"
- .'- 2: 忽略后续调度'."\n"
- .'- 3: 覆盖之前调度',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'StartTimeType' => [
- 'title' => '开始时间类型',
- 'description' => '开始时间类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'EventType' => ['title' => '事件类型', 'description' => '事件类型', 'type' => 'string', 'example' => 'JOB'],
+ 'AppName' => ['description' => '应用名称', 'type' => 'string', 'example' => 'portal-dev'],
+ 'JobName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'test'],
+ 'JobExecutionId' => ['description' => '任务执行ID', 'type' => 'string', 'example' => '101'],
+ 'WorkflowName' => ['title' => '工作流名称', 'description' => '工作流名称', 'type' => 'string', 'example' => '工作流0001'],
+ 'WorkflowExecutionId' => ['title' => '工作流执行记录ID', 'description' => '工作流执行记录ID', 'type' => 'string', 'example' => '1450568762586578000'],
+ 'Event' => ['description' => '事件ID', 'type' => 'string', 'example' => 'info'],
+ 'WorkerAddr' => ['description' => '机器地址', 'type' => 'string', 'example' => '030225016025_9357_60125@127.0.0.1:51363'],
+ 'Content' => ['description' => '日志内容', 'type' => 'string', 'example' => 'hello word'],
+ 'Time' => ['description' => '打印时间，格式为'."\n"
+ .'yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-31 16:43:51'],
],
],
],
- 'Total' => [
- 'title' => '任务扩展属性配置信息',
- 'description' => '总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '65',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'PageNumber' => ['description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '总数量', 'type' => 'integer', 'format' => 'int64', 'example' => '33'],
],
],
],
@@ -5841,48 +3616,37 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"1DF6732E-15D8-5E1F-95E3-C10077F556B5\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"JobId\\": 74,\\n \\"Name\\": \\"job01\\",\\n \\"Description\\": \\"job01单机任务\\",\\n \\"JobType\\": \\"xxljob\\",\\n \\"Status\\": 1,\\n \\"Parameters\\": \\"name=10\\",\\n \\"MaxConcurrency\\": 100,\\n \\"MaxAttempt\\": 5,\\n \\"AttemptInterval\\": 30,\\n \\"JobHandler\\": \\"jobDemoHandler\\",\\n \\"Priority\\": 1,\\n \\"TimeType\\": 1,\\n \\"TimeExpression\\": \\"0 0 12 * * ?\\",\\n \\"TimeZone\\": \\"Hongkong\\",\\n \\"Calendar\\": \\"work-day\\",\\n \\"DataOffset\\": 3,\\n \\"CleanMode\\": \\"{\\\\\\"cleanMode\\\\\\":\\\\\\"NUM_ONLY\\\\\\",\\\\\\"totalRemain\\\\\\":300}\\",\\n \\"Creator\\": \\"1963096506470832\\",\\n \\"Updater\\": \\"1963096506470832\\",\\n \\"Xattrs\\": \\"暂无\\",\\n \\"NoticeConfig\\": \\"{\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failEnable\\\\\\":true,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"timeout\\\\\\":300,\\\\\\"successNotice\\\\\\":false}\\",\\n \\"NoticeContacts\\": \\"[{\\\\\\"contactType\\\\\\":1,\\\\\\"name\\\\\\":\\\\\\"恰橙\\\\\\"}]\\",\\n \\"RouteStrategy\\": 1,\\n \\"AppName\\": \\"test-app\\",\\n \\"Timezone\\": \\"HangKong\\",\\n \\"LastExecuteEndTime\\": \\"2025-06-29 15:56:36\\\\n\\",\\n \\"LastExecuteStatus\\": 4,\\n \\"CurrentExecuteStatus\\": 3,\\n \\"ChildJobId\\": \\"1246\\",\\n \\"Weight\\": 1,\\n \\"NodeType\\": 1,\\n \\"DependentStrategy\\": 1,\\n \\"Script\\": \\"#!/bin/bash\\\\necho \\\\\\"xxl-job: hello shell\\\\\\"\\\\necho \\\\\\"Good bye!\\\\\\"\\\\nexit 0\\",\\n \\"WorkflowId\\": 10,\\n \\"ExecutorBlockStrategy\\": \\"1\\",\\n \\"StartTimeType\\": 1\\n }\\n ],\\n \\"Total\\": 65,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]',
- 'title' => '获取任务列表',
- ],
- 'ListJobScriptHistory' => [
- 'summary' => '获取任务脚本历史列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"EventType\\": \\"JOB\\",\\n \\"AppName\\": \\"portal-dev\\",\\n \\"JobName\\": \\"test\\",\\n \\"JobExecutionId\\": \\"101\\",\\n \\"WorkflowName\\": \\"工作流0001\\",\\n \\"WorkflowExecutionId\\": \\"1450568762586578000\\",\\n \\"Event\\": \\"info\\",\\n \\"WorkerAddr\\": \\"030225016025_9357_60125@127.0.0.1:51363\\",\\n \\"Content\\": \\"hello word\\",\\n \\"Time\\": \\"2024-10-31 16:43:51\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 33\\n }\\n}","type":"json"}]',
+ 'title' => '查询事件',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLogEvent'],
+ ],
],
+ ],
+ 'GetPageLog' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5891,106 +3655,85 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227441',
- 'abilityTreeNodes' => [
- 'FEATUREmseWGXOHM',
- ],
+ 'abilityTreeCode' => '227424',
+ 'abilityTreeNodes' => ['FEATUREmse8C5258'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
],
[
- 'name' => 'JobId',
+ 'name' => 'JobName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '74',
- ],
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'job01'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '任务执行ID', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'WorkerAddr',
'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
+ 'schema' => ['description' => '执行器地址', 'type' => 'string', 'required' => false, 'example' => '192.168.1.100'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '开始时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777292662000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '过期时间戳（毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1777292662000'],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => ['description' => '搜索关键词。', 'type' => 'string', 'required' => false, 'example' => 'hello word'],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '页数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '100'],
+ ],
+ [
+ 'name' => 'Reverse',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否降序：'."\n"
+ ."\n"
+ .' - **true**：按降序排序。'."\n"
+ .' - **false**：按升序排序。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '-',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73',
- ],
- 'Message' => [
- 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'not support query script history, please upgrade engine version to 2.2.2+',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'CalendarName is already existed'],
'Data' => [
'description' => '-',
'type' => 'object',
@@ -6002,106 +3745,64 @@
'description' => '-',
'type' => 'object',
'properties' => [
- 'VersionDescription' => [
- 'description' => '脚本版本描述。',
- 'type' => 'string',
- 'example' => 'init version',
- ],
- 'ScriptContent' => [
- 'description' => '脚本内容。',
- 'type' => 'string',
- 'example' => '#!/bin/bash'."\n"
- .'echo "xxl-job: hello shell"'."\n"
- ."\n"
- .'echo "脚本位置: $0"'."\n"
- .'echo "任务参数: $1"'."\n"
- .'echo "分片序号 = $2"'."\n"
- .'echo "分片总数 = $3"'."\n"
- ."\n"
- .'echo "Good bye!"'."\n"
- .'exit 0',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2025-06-29 15:56:36',
- ],
- 'Creator' => [
- 'description' => '创建人。',
- 'type' => 'string',
- 'example' => '1963096506470832',
- ],
+ 'Time' => ['description' => '打印时间，格式为'."\n"
+ .'yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-10-31 16:43:51'."\n"],
+ 'AppName' => ['description' => '应用名称', 'type' => 'string', 'example' => 'test-app'],
+ 'JobName' => ['description' => '任务名称', 'type' => 'string', 'example' => 'test'],
+ 'JobExecutionId' => ['description' => '任务执行ID', 'type' => 'string', 'example' => '101'],
+ 'Log' => ['description' => '当前命令在当前输出流中输出的内容。', 'type' => 'string', 'example' => '[2026-02-10 10:23:36]tStart writing to Recall Enginen'],
+ 'WorkerAddr' => ['description' => '机器地址', 'type' => 'string', 'example' => '030225016025_9357_60125@127.0.0.1:51363'],
+ 'UserId' => ['description' => '用户ID', 'type' => 'string', 'example' => 'zhangsan'],
],
],
],
- 'NextToken' => [
- 'description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'string',
- 'example' => '21',
- ],
+ 'Total' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '65'],
+ 'PageNum' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取分页日志',
+ 'summary' => '获取分页日志',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"VersionDescription\\": \\"init version\\",\\n \\"ScriptContent\\": \\"#!/bin/bash\\\\necho \\\\\\"xxl-job: hello shell\\\\\\"\\\\n\\\\necho \\\\\\"脚本位置: $0\\\\\\"\\\\necho \\\\\\"任务参数: $1\\\\\\"\\\\necho \\\\\\"分片序号 = $2\\\\\\"\\\\necho \\\\\\"分片总数 = $3\\\\\\"\\\\n\\\\necho \\\\\\"Good bye!\\\\\\"\\\\nexit 0\\",\\n \\"CreateTime\\": \\"2025-06-29 15:56:36\\",\\n \\"Creator\\": \\"1963096506470832\\"\\n }\\n ],\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\",\\n \\"Total\\": \\"21\\"\\n },\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
- 'title' => '获取任务脚本历史列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"CalendarName is already existed\\",\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"Time\\": \\"2024-10-31 16:43:51\\\\n\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"JobName\\": \\"test\\",\\n \\"JobExecutionId\\": \\"101\\",\\n \\"Log\\": \\"[2026-02-10 10:23:36]tStart writing to Recall Enginen\\",\\n \\"WorkerAddr\\": \\"030225016025_9357_60125@127.0.0.1:51363\\",\\n \\"UserId\\": \\"zhangsan\\"\\n }\\n ],\\n \\"Total\\": 65,\\n \\"PageNum\\": 10,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
],
- 'GetDesigateInfo' => [
- 'summary' => '获取指定机器信息。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetWorkflow' => [
+ 'summary' => '获取工作流的基本信息',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6113,44 +3814,25 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '251661',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
- 'autoTest' => true,
+ 'abilityTreeCode' => '227452',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxl-job-executor-sample'],
],
[
- 'name' => 'JobId',
+ 'name' => 'WorkflowId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '74',
- ],
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'],
],
],
'responses' => [
@@ -6160,46 +3842,39 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error'."\n",
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
+ 'description' => '-',
'type' => 'object',
'properties' => [
- 'DesignateType' => [
- 'description' => '指定机器的类型。具体取值如下：'."\n"
- .'- 1：worker。'."\n"
- .'- 2：label。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Transferable' => [
- 'description' => '是否故障转移。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'WorkflowId' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'Name' => ['description' => '工作流名称', 'type' => 'string', 'example' => 'myWorkflow'],
+ 'Description' => ['description' => '工作流描述', 'type' => 'string', 'example' => 'my first workflow'],
+ 'Status' => ['description' => '工作流状态'."\n"
+ .'- 0：禁用'."\n"
+ .'- 1：启用', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'MaxConcurrency' => ['description' => '最大并发数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'TimeType' => ['description' => '调度类型：'."\n"
+ .'- -1: none'."\n"
+ .'- 1：cron'."\n"
+ .'- 100:：api', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TimeExpression' => ['description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
+ .'- **none**：无需填写'."\n"
+ .'- **cron**：填写标准的cron表达式，支持在线验证。'."\n"
+ .'- **api**：无需填写', 'type' => 'string', 'example' => '0 0 12 * * ?'],
+ 'Timezone' => ['description' => '时区'."\n"
+ .'> 默认使用当前region服务器所在时区', 'type' => 'string', 'example' => 'GMT+8'],
+ 'Calendar' => ['description' => '自定义日历', 'type' => 'string', 'example' => 'workday'],
+ 'Creator' => ['description' => '创建人。', 'type' => 'string', 'example' => '18582193685027xx'],
+ 'Updater' => ['description' => '更新人。', 'type' => 'string', 'example' => '18582193685027xx'],
+ 'Xattrs' => ['description' => '扩展属性。'."\n"
+ .'> 暂不支持', 'type' => 'string', 'example' => 'null'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
],
],
],
@@ -6208,52 +3883,31 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DF6732E-15D8-5E1F-95E3-C10077F556B5\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DesignateType\\": 2,\\n \\"Transferable\\": true\\n }\\n}","type":"json"}]',
- 'title' => '获取指定机器信息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkflowId\\": 10,\\n \\"Name\\": \\"myWorkflow\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"Status\\": 2,\\n \\"MaxConcurrency\\": 100,\\n \\"TimeType\\": 1,\\n \\"TimeExpression\\": \\"0 0 12 * * ?\\",\\n \\"Timezone\\": \\"GMT+8\\",\\n \\"Calendar\\": \\"workday\\",\\n \\"Creator\\": \\"18582193685027xx\\",\\n \\"Updater\\": \\"18582193685027xx\\",\\n \\"Xattrs\\": \\"null\\",\\n \\"AppName\\": \\"test-app\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取工作流的基本信息',
+ 'changeSet' => [],
],
- 'GetJobExecution' => [
- 'summary' => '获取任务执行的详细信息。',
+ 'GetWorkflowDAG' => [
+ 'summary' => '获取工作流DAG信息',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6265,49 +3919,25 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmseWGXOHM',
- ],
+ 'abilityTreeCode' => '260227',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'JobExecutionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'MseSessionId',
+ 'name' => 'WorkflowId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
],
'responses' => [
@@ -6317,162 +3947,53 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '-',
+ 'description' => '查询结果。',
'type' => 'object',
'properties' => [
- 'JobExecutionId' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'example' => '1310630367761285120',
- ],
- 'JobId' => [
- 'description' => '任务id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '74',
- ],
- 'JobName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '天猫-自动审单',
- ],
- 'JobType' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'example' => 'xxljob',
- ],
- 'Parameters' => [
- 'description' => '任务参数。',
- 'type' => 'string',
- 'example' => '/home/avatar/system/services/biz/payment/crontab/monitorpayment.php',
- ],
- 'ScheduleTime' => [
- 'description' => '任务调度时间。',
- 'type' => 'string',
- 'example' => '2025-03-11 00:06:10',
- ],
- 'DataTime' => [
- 'description' => '任务数据时间。',
- 'type' => 'string',
- 'example' => '2025-03-11 00:06:10',
- ],
- 'StartTime' => [
- 'description' => '部署任务执行开始时间（秒，时间戳格式）。',
- 'type' => 'string',
- 'example' => '2025-03-11 00:06:10',
- ],
- 'EndTime' => [
- 'description' => '过期时间',
- 'type' => 'string',
- 'example' => '2024-10-29 15:56:36',
- ],
- 'Duration' => [
- 'description' => '运行总时长。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Executor' => [
- 'description' => '执行者ID。',
- 'type' => 'string',
- 'example' => '{\'Status\': \'NORMAL\', \'ActiveCount\': 4, \'UnavailableCount\': 0, \'ExpectedCount\': 4, \'RiskCount\': 0}',
- ],
- 'Result' => [
- 'description' => '返回结果。',
- 'type' => 'string',
- 'example' => '[]',
- ],
- 'Status' => [
- 'description' => '任务执行状态。具体说明如下：'."\n"
- .'- 0: UNKNOWN (未知)。'."\n"
- .'- 1: WAITING (等待)。'."\n"
- .'- 2: READY (准备就绪)。'."\n"
- .'- 3: RUNNING (运行中)。'."\n"
- .'- 4: SUCCESS (成功)。'."\n"
- .'- 5: FAILED (失败)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'TimeType' => [
- 'description' => '时间类型：'."\n"
- .'- -1: none'."\n"
- .'- 1：cron'."\n"
- .'- 2: fixed_delay'."\n"
- .'- 3：fixed_rate'."\n"
- .'- 5：one_time'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Attempt' => [
- 'description' => '失败尝试次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'RouteStrategy' => [
- 'description' => '路由策略。具体取值如下：'."\n"
- .'- 1: 轮询'."\n"
- .'- 2: 随机'."\n"
- .'- 3: 第一个'."\n"
- .'- 4: 最后一个'."\n"
- .'- 5: 最不经常使用'."\n"
- .'- 6: 最近最久未使用'."\n"
- .'- 7: 一致性哈希'."\n"
- .'- 8: 分片广播',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ServerIp' => [
- 'description' => '调度节点。',
- 'type' => 'string',
- 'example' => '172.3.27.76',
+ 'Nodes' => [
+ 'description' => '返回的数据类型。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回的数据类型。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'Name' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'job1'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'oak-payment-async-job'],
+ 'Status' => ['description' => '任务状态'."\n"
+ .'- 0：禁用'."\n"
+ .'- 1：启用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'JobType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'script_shell'],
+ 'Coordinate' => [
+ 'description' => '节点的坐标信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['description' => '节点的X轴坐标', 'type' => 'number', 'format' => 'float', 'example' => '50'],
+ 'Y' => ['description' => '节点的Y轴坐标', 'type' => 'number', 'format' => 'float', 'example' => '50'],
+ 'Width' => ['description' => '节点宽度，可以不填', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ 'Height' => ['description' => '节点高度，可以不填', 'type' => 'number', 'format' => 'float', 'example' => '20'],
+ ],
+ ],
+ 'DependentStrategy' => ['description' => '依赖策略', 'type' => 'integer', 'format' => 'int32', 'example' => 'all_success'],
+ ],
+ ],
],
- 'TriggerType' => [
- 'description' => '任务触发类型。具体说明如下：'."\n"
- .'- 0：unknown。'."\n"
- .'- 1：timer_schedule。'."\n"
- .'- 2：rerun。'."\n"
- .'- 3：api_run。'."\n"
- .'- 4：user_retry。'."\n"
- .'- 5：system_retry。'."\n"
- .'- 6：manual。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'timer_schedule',
+ 'Edges' => [
+ 'description' => '工作流边列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '节点之间的边',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['description' => '边起点的任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'Target' => ['description' => '边终点的任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ ],
+ ],
],
],
],
@@ -6482,115 +4003,68 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"Id\\": 5,\\n \\"Name\\": \\"job1\\",\\n \\"AppName\\": \\"oak-payment-async-job\\",\\n \\"Status\\": 1,\\n \\"JobType\\": \\"script_shell\\",\\n \\"Coordinate\\": {\\n \\"X\\": 50,\\n \\"Y\\": 50,\\n \\"Width\\": 100,\\n \\"Height\\": 20\\n },\\n \\"DependentStrategy\\": 0\\n }\\n ],\\n \\"Edges\\": [\\n {\\n \\"Source\\": 3,\\n \\"Target\\": 4\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '获取工作流DAG信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobExecutionId\\": \\"1310630367761285120\\",\\n \\"JobId\\": 74,\\n \\"JobName\\": \\"天猫-自动审单\\",\\n \\"JobType\\": \\"xxljob\\",\\n \\"Parameters\\": \\"/home/avatar/system/services/biz/payment/crontab/monitorpayment.php\\",\\n \\"ScheduleTime\\": \\"2025-03-11 00:06:10\\",\\n \\"DataTime\\": \\"2025-03-11 00:06:10\\",\\n \\"StartTime\\": \\"2025-03-11 00:06:10\\",\\n \\"EndTime\\": \\"2024-10-29 15:56:36\\",\\n \\"Duration\\": 1,\\n \\"Executor\\": \\"{\'Status\': \'NORMAL\', \'ActiveCount\': 4, \'UnavailableCount\': 0, \'ExpectedCount\': 4, \'RiskCount\': 0}\\",\\n \\"Result\\": \\"[]\\",\\n \\"Status\\": 4,\\n \\"TimeType\\": 1,\\n \\"Attempt\\": 1,\\n \\"AppName\\": \\"test-app\\",\\n \\"RouteStrategy\\": 1,\\n \\"ServerIp\\": \\"172.3.27.76\\",\\n \\"TriggerType\\": 0\\n }\\n}","type":"json"}]',
- 'title' => '获取任务执行的详细信息',
],
- 'OperateStopJobExecution' => [
- 'summary' => '停止正在运行的任务实例。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetWorkflowDAGPreview' => [
+ 'summary' => '获取工作流历史版本的DAG',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227437',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '260227',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'JobExecutionId',
+ 'name' => 'WorkflowId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'TaskList',
+ 'name' => 'DagVersion',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '子任务ID',
- 'description' => '子任务ID',
- 'type' => 'array',
- 'items' => [
- 'title' => '子任务id',
- 'description' => '子任务id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[1,2,3]',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '工作流DAG的版本号', 'type' => 'string', 'required' => true, 'example' => 'v1'],
],
],
'responses' => [
@@ -6600,27 +4074,57 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'E82D8B33-204D-58E1-8F56-909F6B48F3D1',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。**true**：调用成功。**false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B8733786-C045-59F1-8D79-99A52863F62D'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Nodes' => [
+ 'description' => '工作流节点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'Name' => ['description' => '任务名称', 'type' => 'string', 'example' => 'job1'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'settle-job'],
+ 'Status' => ['description' => '任务状态：'."\n"
+ .'- 0: 禁用'."\n"
+ .'- 1: 启用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'JobType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'script_shell'],
+ 'Coordinate' => [
+ 'description' => '节点的坐标信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['description' => '节点的X轴坐标', 'type' => 'number', 'format' => 'float', 'example' => '50'],
+ 'Y' => ['description' => '节点的Y轴坐标', 'type' => 'number', 'format' => 'float', 'example' => '50'],
+ 'Width' => ['description' => '节点宽度，可以不填', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ 'Height' => ['description' => '节点高度，可以不填', 'type' => 'number', 'format' => 'float', 'example' => '20'],
+ ],
+ ],
+ 'DependentStrategy' => ['description' => '依赖策略', 'type' => 'integer', 'format' => 'int32', 'example' => 'all_success'],
+ ],
+ ],
+ ],
+ 'Edges' => [
+ 'description' => '工作流的边列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '工作流的边信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['description' => '边起始节点的任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
+ 'Target' => ['description' => '边终点的任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ ],
+ ],
+ ],
+ ],
],
],
],
@@ -6628,142 +4132,194 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E82D8B33-204D-58E1-8F56-909F6B48F3D1\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '停止正在运行的任务实例',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8733786-C045-59F1-8D79-99A52863F62D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"Id\\": 3,\\n \\"Name\\": \\"job1\\",\\n \\"AppName\\": \\"settle-job\\",\\n \\"Status\\": 1,\\n \\"JobType\\": \\"script_shell\\",\\n \\"Coordinate\\": {\\n \\"X\\": 50,\\n \\"Y\\": 50,\\n \\"Width\\": 100,\\n \\"Height\\": 20\\n },\\n \\"DependentStrategy\\": 0\\n }\\n ],\\n \\"Edges\\": [\\n {\\n \\"Source\\": 3,\\n \\"Target\\": 4\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '获取工作流历史版本的DAG',
+ 'changeSet' => [],
],
- 'OperateDesignateExecutors' => [
- 'summary' => '指定执行器。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetWorkflowExecutionDAG' => [
+ 'summary' => '获取工作流实例的DAG信息',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227425',
- 'abilityTreeNodes' => [
- 'FEATUREmseWGXOHM',
- ],
+ 'abilityTreeCode' => '260227',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'WorkflowExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流执行ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
+ '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' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter format error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '查询结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Nodes' => [
+ 'description' => '节点信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '节点信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'ID。', 'type' => 'string', 'example' => '7491777526619542799'],
+ 'Name' => ['description' => '任务名称', 'type' => 'string', 'example' => 'job1'],
+ 'AppName' => ['description' => '应用名称', 'type' => 'string', 'example' => 'cua-xxl-job-executor'],
+ 'Status' => ['description' => '任务执行状态。具体说明如下：'."\n"
+ .'- 0: unknown'."\n"
+ .'- 1: waiting '."\n"
+ .'- 2: queued'."\n"
+ .'- 3: running'."\n"
+ .'- 4: success'."\n"
+ .'- 5: failed'."\n"
+ .'- 6: killed'."\n"
+ .'- 7: held'."\n"
+ .'- 8: mark_success'."\n"
+ .'- 9: skipped', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'JobType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'script_shell'],
+ 'Coordinate' => [
+ 'description' => '节点的坐标信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['description' => '节点的X轴坐标', 'type' => 'number', 'format' => 'float', 'example' => '50'],
+ 'Y' => ['description' => '节点的Y轴坐标', 'type' => 'number', 'format' => 'float', 'example' => '50'],
+ 'Width' => ['description' => '节点宽度，可以不填', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ 'Height' => ['description' => '节点高度，可以不填', 'type' => 'number', 'format' => 'float', 'example' => '20'],
+ ],
+ ],
+ 'JobId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
+ ],
+ ],
+ ],
+ 'Edges' => [
+ 'description' => '工作流的边列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '通过source->target描述边信息，source=0表示根节点',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['description' => '边起点的任务执行ID', 'type' => 'string', 'example' => '1000'],
+ 'Target' => ['description' => '边终点的任务执行ID', 'type' => 'string', 'example' => '1001'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
+ ],
[
- 'name' => 'JobId',
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"Id\\": \\"7491777526619542799\\",\\n \\"Name\\": \\"job1\\",\\n \\"AppName\\": \\"cua-xxl-job-executor\\",\\n \\"Status\\": 4,\\n \\"JobType\\": \\"script_shell\\",\\n \\"Coordinate\\": {\\n \\"X\\": 50,\\n \\"Y\\": 50,\\n \\"Width\\": 100,\\n \\"Height\\": 20\\n },\\n \\"JobId\\": 9\\n }\\n ],\\n \\"Edges\\": [\\n {\\n \\"Source\\": \\"1000\\",\\n \\"Target\\": \\"1001\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '获取工作流实例的DAG信息',
+ 'changeSet' => [],
+ ],
+ 'ImportCalendar' => [
+ 'summary' => '导入日历。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227446',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '74',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '日历名。', 'type' => 'string', 'required' => true, 'example' => 'workday'],
],
[
- 'name' => 'Transferable',
+ 'name' => 'Year',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否故障转移。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
],
[
- 'name' => 'DesignateType',
+ 'name' => 'Months',
'in' => 'formData',
- 'schema' => [
- 'description' => '指定机器的类型。取值如下：'."\n"
- .'- **1**：指定worker。'."\n"
- .'- **2**：指定label。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- 'enum' => [
- '1',
- '2',
- ],
- ],
+ 'schema' => ['description' => '月。', 'type' => 'string', 'required' => true, 'example' => '[{"month":1,"days":[3,4,5,6,9,10,11,12,13,16,17,18,19,20,28,29,30,31]},{"month":2,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28]},{"month":3,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},{"month":4,"days":[3,4,6,7,10,11,12,13,14,17,18,19,20,21,23,24,25,26,27,28]},{"month":5,"days":[4,5,6,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]},{"month":6,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,25,26,27,28,29,30]},{"month":7,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},{"month":8,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},{"month":9,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28]},{"month":10,"days":[7,8,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30,31]},{"month":11,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30]},{"month":12,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]}]'],
],
[
- 'name' => 'AddressList',
+ 'name' => 'ClusterId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '地址列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '机器地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://192.168.***.5:9999/',
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
],
'responses' => [
@@ -6773,28 +4329,16 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335',
- ],
- 'Success' => [
- 'description' => '是否调用成功。具体取值如下：'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的<br />唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => ['description' => '返回数据。', 'type' => 'string', 'example' => 'refresh calendar success'],
+ 'description' => '',
],
],
],
@@ -6802,51 +4346,30 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"AFD5B166-4A7D-50DF-91BF-EFAFD41F7335\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '指定执行器',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"refresh calendar success\\"\\n ]\\n}","type":"json"}]',
+ 'title' => '导入日历',
+ 'changeSet' => [],
],
- 'OperateRetryJobExecution' => [
- 'summary' => '重跑失败的任务实例。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ImportJobs' => [
+ 'summary' => '批量导入任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6858,69 +4381,85 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227436',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '227422',
+ 'abilityTreeNodes' => ['FEATUREmse7UN7CQ'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'JobExecutionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1310630367761285120',
- ],
+ 'name' => 'Overwrite',
+ 'in' => 'formData',
+ 'schema' => ['description' => '如果已存在，是否覆盖。默认值为 true。'."\n"
+ .'- true：覆盖。'."\n"
+ .'- false：不覆盖。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
- 'name' => 'TaskList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '子任务执行 ID列表（分片广播任务）。'."\n"
- .'>在需要重跑某个分片广播任务的子任务时，请将此字段设置为相应子任务的执行 ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '子任务执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1311649782220996611'."\n",
- ],
- 'required' => false,
- ],
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['description' => '导入内容。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "kind": "SchedulerXJobs",'."\n"
+ .' "type": "JSON",'."\n"
+ .' "version": "2.0",'."\n"
+ .' "content": ['."\n"
+ .' {'."\n"
+ .' "appName": "xxl-job-executor-perf-test-xx",'."\n"
+ .' "groupId": "xxl-job-executor-perf-test-xx",'."\n"
+ .' "description": "xxl-job-executor-xx",'."\n"
+ .' "jobConfigInfo": ['."\n"
+ .' {'."\n"
+ .' "jobHandler": "testJobVoidHandler",'."\n"
+ .' "dataOffset": 0,'."\n"
+ .' "executeMode": "standalone",'."\n"
+ .' "monitorConfigInfo": {'."\n"
+ .' "alarmType": "CustomContacts",'."\n"
+ .' "failLimitTimes": 1,'."\n"
+ .' "failEnable": true,'."\n"
+ .' "failRate": 100,'."\n"
+ .' "timeoutKillEnable": false,'."\n"
+ .' "missWorkerEnable": false,'."\n"
+ .' "sendChannel": "webhook",'."\n"
+ .' "timeoutEnable": true,'."\n"
+ .' "timeout": 7200,'."\n"
+ .' "daysOfDeadline": 0,'."\n"
+ .' "successNotice": false'."\n"
+ .' },'."\n"
+ .' "attemptInterval": 30,'."\n"
+ .' "cleanMode": "{\\"cleanMode\\":\\"NUM_ONLY\\",\\"totalRemain\\":300}",'."\n"
+ .' "description": "",'."\n"
+ .' "routeStrategy": 1,'."\n"
+ .' "userName": "xx",'."\n"
+ .' "userId": "xx",'."\n"
+ .' "content": "{\\"jobHandler\\":\\"testJobVoidHandler\\"}",'."\n"
+ .' "maxConcurrency": 1,'."\n"
+ .' "maxAttempt": 0,'."\n"
+ .' "name": "perf_auto_test_0",'."\n"
+ .' "xattrs": "",'."\n"
+ .' "jobType": "xxljob",'."\n"
+ .' "contentType": 1,'."\n"
+ .' "parameters": "success-withMsg",'."\n"
+ .' "timeConfig": {'."\n"
+ .' "calendar": "",'."\n"
+ .' "dataOffset": 0,'."\n"
+ .' "timeType": 1,'."\n"
+ .' "paramMap": {},'."\n"
+ .' "timeExpression": "* * * * * ?"'."\n"
+ .' },'."\n"
+ .' "contactInfoList": [],'."\n"
+ .' "status": 0'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'],
],
[
- 'name' => 'TriggerChild',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否触发下游',
- 'description' => '是否触发下游',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'true',
- ],
+ 'name' => 'AutoCreateApp',
+ 'in' => 'formData',
+ 'schema' => ['description' => '自动创建应用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -6930,249 +4469,123 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '438737AC-760A-57D9-B646-B7EF79426243',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- true：调用成功。 '."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '详细信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"438737AC-760A-57D9-B646-B7EF79426243\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
- 'title' => '重跑任务实例',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E\\",\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '批量导入任务',
+ 'changeSet' => [],
],
- 'OperateExecuteJob' => [
- 'summary' => '运行一次任务。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ImportWorkflows' => [
+ 'summary' => '导入工作流',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227439',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '227422',
+ 'abilityTreeNodes' => ['FEATUREmse7UN7CQ'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
[
- 'name' => 'JobId',
+ 'name' => 'Overwrite',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '74',
- ],
+ 'schema' => ['description' => '如果已存在，是否覆盖。默认值为 true。'."\n"
+ .'- true：覆盖。'."\n"
+ .'- false：不覆盖。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
- 'name' => 'InstanceParameters',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'description' => '实例参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'name=zhangsan',
- ],
+ 'schema' => ['description' => '导入内容。', 'type' => 'string', 'required' => false, 'example' => '[{"kind":"SchedulerXWorkflows","type":"JSON","version":"2.0","workflowInfo":{"name":"myWorkflow","description":"","appName":"xuerentest","appType":1,"maxConcurrency":1,"currentExecuteStatus":0,"timeConfig":{"timeType":1,"timeExpression":"0 0 12 * * ?","dataOffset":0}},"nodes":[{"name":"Java1","startTime":-1,"coordinate":{"x":-222.0,"y":40.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld\\"}","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell1","startTime":-1,"coordinate":{"x":102.0,"y":-51.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"Java2","startTime":-1,"coordinate":{"x":390.0,"y":55.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld2\\"}","xattrs":"{\\"executorBlockStrategy\\":1,\\"localParams\\":[]}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell2","startTime":-1,"coordinate":{"x":89.0,"y":161.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world2\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]}],"edges":[{"from":"Java1","to":"shell1"},{"from":"Java1","to":"shell2"},{"from":"Schedulerx-Root","to":"Java1"},{"from":"shell1","to":"Java2"},{"from":"shell2","to":"Java2"}]}]'],
],
[
- 'name' => 'Worker',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '指定机器的workerAddr',
- 'description' => '指定机器的workerAddr。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://192.168.***.5:9999/',
- ],
- ],
- [
- 'name' => 'Label',
+ 'name' => 'AutoCreateApp',
'in' => 'formData',
- 'schema' => [
- 'title' => '指定机器的标签',
- 'description' => '指定机器的标签。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gray',
- ],
+ 'schema' => ['description' => '自动创建应用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题',
- 'type' => 'string',
- 'example' => '6305893D-517D-5131-A767-644EDA81CEC3',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'JobExecutionId' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'example' => '1310630367761285120',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"6305893D-517D-5131-A767-644EDA81CEC3\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobExecutionId\\": \\"1310630367761285120\\"\\n }\\n}","type":"json"}]',
- 'title' => '运行一次任务',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '导入工作流',
+ 'changeSet' => [],
],
- 'GetJobExecutionProgress' => [
- 'summary' => '获取任务执行的详情。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListAlarmEvent' => [
+ 'summary' => '获取报警事件。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7181,45 +4594,81 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227428',
- 'abilityTreeNodes' => [
- 'FEATUREmseWGXOHM',
- ],
+ 'abilityTreeCode' => '253617',
+ 'abilityTreeNodes' => ['FEATUREmse8C5258'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
],
[
- 'name' => 'JobExecutionId',
+ 'name' => 'JobName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'test-job'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '检索到事件的开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1690419316000'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '检索到事件的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731636011558'],
+ ],
+ [
+ 'name' => 'AlarmType',
+ 'in' => 'query',
+ 'schema' => ['description' => '报警类型。具体说明如下：'."\n"
+ .'- **`schedulerx3_no_designate_machine_alarm`**（指定机器不可用报警）。'."\n"
+ .'- **`schedulerx3_all_busy_alarm`**（所有机器繁忙报警）。'."\n"
+ .'- **`schedulerx3_no_machine_alarm`**（无可用机器报警）。'."\n"
+ .'- **`schedulerx3_timeout_alarm`**（任务超时报警）。'."\n"
+ .'- **`schedulerx3_fail_alarm`**（任务执行失败报警）。'."\n"
+ .'- **`schedulerx3_job_success_notice`**（任务执行成功）。', 'type' => 'string', 'required' => false, 'example' => 'schedulerx3_fail_alarm'],
+ ],
+ [
+ 'name' => 'AlarmChannel',
+ 'in' => 'query',
+ 'schema' => ['description' => '报警渠道。具体说明如下：'."\n"
+ .'- `sms` （短信）。'."\n"
+ .'- `mail` （邮箱）。'."\n"
+ .'- `phone`（电话）。'."\n"
+ .'- `webhook`（webhook）。', 'type' => 'string', 'required' => false, 'example' => 'webhook'],
+ ],
+ [
+ 'name' => 'AlarmStatus',
+ 'in' => 'query',
+ 'schema' => ['description' => '报警状态。具体说明如下：'."\n"
+ ."\n"
+ .'- `true`：报警信息发送成功。'."\n"
+ ."\n"
+ .'- `false`：报警信息发送失败。', 'type' => 'string', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小。', 'type' => 'string', 'required' => false, 'example' => '10', 'default' => '20'],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。', 'type' => 'string', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'Reverse',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
],
'responses' => [
@@ -7229,257 +4678,47 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '9B57FDD7-ABBE-5030-B348-86EB9943DB59',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter format error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'type' => 'object',
'properties' => [
- 'JobDescription' => [
- 'description' => '任务描述。',
- 'type' => 'string',
- 'example' => '测试任务',
- ],
- 'TotalProgress' => [
- 'description' => '任务整体进度。',
- 'type' => 'object',
- 'properties' => [
- 'Total' => [
- 'description' => '总数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30',
- ],
- 'Finished' => [
- 'description' => '完成的数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15',
- ],
- ],
- ],
- 'RootProgress' => [
- 'description' => '根任务进度。',
- 'type' => 'object',
- 'properties' => [
- 'Total' => [
- 'description' => '总数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'Finished' => [
- 'description' => '完成的数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
- 'TaskProgress' => [
- 'description' => '子任务进度。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => 'calendar_test_2',
- ],
- 'Total' => [
- 'description' => '总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'Pulled' => [
- 'description' => '已拉取数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Queue' => [
- 'description' => '队列中数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Running' => [
- 'description' => '运行中数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Success' => [
- 'description' => '成功的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Failed' => [
- 'description' => '已失败数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- ],
- 'ShardingProgress' => [
- 'description' => '分片任务进度。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'WorkerAddr' => [
- 'description' => '机器地址。',
- 'type' => 'string',
- 'example' => 'http://192.168.***.9:9999/',
- ],
- 'Status' => [
- 'description' => '任务执行状态。具体说明如下：'."\n"
- .'- 0：unknown。'."\n"
- .'- 1：init。'."\n"
- .'- 2：pulled。'."\n"
- .'- 3：running。'."\n"
- .'- 4：success。'."\n"
- .'- 5：failed。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'StatusType' => [
- 'description' => '状态类型。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '任务状态码。',
- 'type' => 'string',
- 'example' => '5',
- ],
- 'Name' => [
- 'description' => '状态名称',
- 'type' => 'string',
- 'example' => 'TaskStatus.FAILED',
- ],
- 'Tips' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'Task execution failed',
- 'description' => '提示信息。',
- ],
- ],
- ],
- ],
- 'JobExecutionId' => [
- 'description' => '分片执行ID。',
- 'type' => 'string',
- 'example' => '1306189481388277762',
- ],
- 'Result' => [
- 'description' => '分片执行结果。',
- 'type' => 'string',
- 'example' => '2,4,6,8,10',
- ],
- ],
- ],
- ],
- 'WorkerProgress' => [
- 'description' => '机器维度执行进度。',
+ 'Records' => [
+ 'description' => '结果集。',
'type' => 'array',
'items' => [
+ 'description' => '数据列表。',
'type' => 'object',
'properties' => [
- 'WorkerAddr' => [
- 'description' => '机器地址。',
- 'type' => 'string',
- 'example' => '10.***.***.53:61941'."\n",
- ],
- 'Total' => [
- 'description' => '总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Pulled' => [
- 'description' => '已拉取数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Queue' => [
- 'description' => '队列中数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Running' => [
- 'description' => '运行中数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Success' => [
- 'description' => '成功的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Failed' => [
- 'description' => '已失败数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TraceId' => [
- 'description' => '全链路ID。',
- 'type' => 'string',
- 'example' => '1a0e97fb17244665327205402dbd6d',
- ],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ 'JobName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'test-job'],
+ 'AlarmType' => ['description' => '报警类型。', 'type' => 'string', 'example' => 'schedulerx3_fail_alarm'],
+ 'AlarmChannel' => ['description' => '报警渠道。', 'type' => 'string', 'example' => 'webhook'],
+ 'AlarmContacts' => ['description' => '报警联系人。', 'type' => 'string', 'example' => 'zhangsan'],
+ 'AlarmStatus' => ['description' => '报警状态。', 'type' => 'string', 'example' => 'true'],
+ 'AlarmMessage' => ['description' => '报警信息。', 'type' => 'string', 'example' => '报警类型：任务执行失败报警'."\n"
+ .'运行环境：cn-xx'."\n"
+ .'集群：xxljob-b6ec1acfb2c'."\n"
+ .'应用名：testApp'."\n"
+ .'任务ID及名称：8(failedjob)'."\n"
+ .'实例ID：1308'."\n"
+ .'触发时间：2024-11-19 13:57:10'."\n"
+ .'失败次数：187'."\n"
+ .'运行机器：http://192.***.***.5:9999/'."\n"
+ .'失败原因：java.lang.reflect.InvocationTargetException'],
+ 'Time' => ['description' => '格式为`yyyy-MM-dd HH:mm:ss`。', 'type' => 'string', 'example' => '2024-10-31 16:43:51'."\n"],
],
],
],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '开始时间',
- 'type' => 'string',
- 'example' => '1758506761000',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '结束时间',
- 'type' => 'string',
- 'example' => '1758594961000',
- ],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '64'],
],
+ 'description' => '',
],
],
],
@@ -7487,50 +4726,30 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"9B57FDD7-ABBE-5030-B348-86EB9943DB59\\",\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobDescription\\": \\"测试任务\\",\\n \\"TotalProgress\\": {\\n \\"Total\\": 30,\\n \\"Finished\\": 15\\n },\\n \\"RootProgress\\": {\\n \\"Total\\": 2,\\n \\"Finished\\": 2\\n },\\n \\"TaskProgress\\": [\\n {\\n \\"Name\\": \\"calendar_test_2\\",\\n \\"Total\\": 1000,\\n \\"Pulled\\": 10,\\n \\"Queue\\": 100,\\n \\"Running\\": 1,\\n \\"Success\\": 100,\\n \\"Failed\\": 100\\n }\\n ],\\n \\"ShardingProgress\\": [\\n {\\n \\"Id\\": 1,\\n \\"WorkerAddr\\": \\"http://192.168.***.9:9999/\\",\\n \\"Status\\": 5,\\n \\"StatusType\\": {\\n \\"Code\\": \\"5\\",\\n \\"Name\\": \\"TaskStatus.FAILED\\",\\n \\"Tips\\": {\\n \\"key\\": \\"Task execution failed\\"\\n }\\n },\\n \\"JobExecutionId\\": \\"1306189481388277762\\",\\n \\"Result\\": \\"2,4,6,8,10\\"\\n }\\n ],\\n \\"WorkerProgress\\": [\\n {\\n \\"WorkerAddr\\": \\"10.***.***.53:61941\\\\n\\",\\n \\"Total\\": 100,\\n \\"Pulled\\": 20,\\n \\"Queue\\": 20,\\n \\"Running\\": 20,\\n \\"Success\\": 20,\\n \\"Failed\\": 20,\\n \\"TraceId\\": \\"1a0e97fb17244665327205402dbd6d\\"\\n }\\n ],\\n \\"StartTime\\": \\"1758506761000\\",\\n \\"EndTime\\": \\"1758594961000\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取任务执行的详情',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"AppName\\": \\"test-app\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"AlarmType\\": \\"schedulerx3_fail_alarm\\",\\n \\"AlarmChannel\\": \\"webhook\\",\\n \\"AlarmContacts\\": \\"zhangsan\\",\\n \\"AlarmStatus\\": \\"true\\",\\n \\"AlarmMessage\\": \\"报警类型：任务执行失败报警\\\\n运行环境：cn-xx\\\\n集群：xxljob-b6ec1acfb2c\\\\n应用名：testApp\\\\n任务ID及名称：8(failedjob)\\\\n实例ID：1308\\\\n触发时间：2024-11-19 13:57:10\\\\n失败次数：187\\\\n运行机器：http://192.***.***.5:9999/\\\\n失败原因：java.lang.reflect.InvocationTargetException\\",\\n \\"Time\\": \\"2024-10-31 16:43:51\\\\n\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 64\\n }\\n}","type":"json"}]',
+ 'title' => '获取报警事件',
+ 'changeSet' => [],
],
- 'GetJobExecutionThreadDump' => [
- 'summary' => '查询任务执行堆栈。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListAppNames' => [
+ 'summary' => '获取应用名称列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7539,55 +4758,22 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '260227',
- 'abilityTreeNodes' => [
- 'FEATUREmseWJZKU4',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227427',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxl-job-executor-sample',
- ],
- ],
- [
- 'name' => 'JobExecutionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
- ],
- ],
- [
- 'name' => 'ExecutorAddr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '执行器地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://192.168.0.215:9966/',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
],
],
'responses' => [
@@ -7597,38 +4783,27 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '详细信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: appId is null.',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3881C59F-59F1-5B2E-8110-7D689CA9B207'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'Dump' => [
- 'description' => '堆栈信息',
- 'type' => 'string',
- 'example' => '\\"Thread-7\\" Id=67 TIMED_WAITING\\n\\tat java.base@17.0.5/java.lang.Thread.sleep(Native Method)\\n\\tat app//com.xxl.job.executor.service.jobhandler.SampleXxlJob.shardingJobHandler(SampleXxlJob.java:73)\\n\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\\n\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)\\n\\tat java.base@17.0.5/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\\n\\tat java.base@17.0.5/java.lang.reflect.Method.invoke(Method.java:568)\\n\\tat app//com.xxl.job.core.handler.impl.MethodJobHandler.execute(MethodJobHandler.java:29)\\n\\tat app//com.xxl.job.core.thread.JobThread.run(JobThread.java:152)\\n',
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '主键。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ 'Title' => ['description' => '标题。', 'type' => 'string', 'example' => '测试应用'],
+ 'AppGroupId' => ['description' => '任务分组ID。', 'type' => 'string', 'example' => 'test-app'."\n"],
+ 'AppType' => ['title' => '应用类型', 'description' => '应用类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WorkerRegistry' => ['title' => '手动注册执行器类型', 'description' => '手动注册执行器类型', 'type' => 'string', 'example' => 'k8s_service'],
+ ],
+ 'description' => '',
],
+ 'description' => '',
],
],
],
@@ -7636,55 +4811,37 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: appId is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Dump\\": \\"\\\\\\\\\\\\\\"Thread-7\\\\\\\\\\\\\\" Id=67 TIMED_WAITING\\\\\\\\n\\\\\\\\tat java.base@17.0.5/java.lang.Thread.sleep(Native Method)\\\\\\\\n\\\\\\\\tat app//com.xxl.job.executor.service.jobhandler.SampleXxlJob.shardingJobHandler(SampleXxlJob.java:73)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\\\\\\\\n\\\\\\\\tat java.base@17.0.5/java.lang.reflect.Method.invoke(Method.java:568)\\\\\\\\n\\\\\\\\tat app//com.xxl.job.core.handler.impl.MethodJobHandler.execute(MethodJobHandler.java:29)\\\\\\\\n\\\\\\\\tat app//com.xxl.job.core.thread.JobThread.run(JobThread.java:152)\\\\\\\\n\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询任务执行堆栈',
- 'description' => '# 引入增强插件'."\n"
- ."\n"
- .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
- ."\n"
- .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
- ."\n"
- .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
- ],
- 'ListJobExecutions' => [
- 'summary' => '获取任务实例列表。',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3881C59F-59F1-5B2E-8110-7D689CA9B207\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Id\\": 15,\\n \\"AppName\\": \\"test-app\\",\\n \\"Title\\": \\"测试应用\\",\\n \\"AppGroupId\\": \\"test-app\\\\n\\",\\n \\"AppType\\": 1,\\n \\"WorkerRegistry\\": \\"k8s_service\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取应用名称列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppNames'],
+ ],
],
+ ],
+ 'ListApps' => [
+ 'summary' => '获取应用列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7693,379 +4850,91 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227441',
- 'abilityTreeNodes' => [
- 'FEATUREmseWGXOHM',
- ],
+ 'abilityTreeCode' => '227431',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'WorkflowExecutionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作流实例ID',
- 'description' => '工作流实例ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'JobId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '74',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
],
[
- 'name' => 'JobName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-job',
- ],
- ],
- [
- 'name' => 'JobExecutionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务执行状态。具体说明如下：'."\n"
- .'- 0: **UNKNOWN (未知)**。'."\n"
- .'- 1: **WAITING (等待)**。'."\n"
- .'- 2: **READY (准备就绪)**。'."\n"
- .'- 3: **RUNNING (运行中)**。'."\n"
- .'- 4: **SUCCESS (成功)**。'."\n"
- .'- 5: **FAILED (失败)**。'."\n"
- .'- 6: **PAUSED (已暂停)**。'."\n"
- .'- 7: **SUBMITTED (已提交)**。'."\n"
- .'- 8: **REJECTED (被拒绝)**。'."\n"
- .'- 9: **ACCEPTED (已接受)**。'."\n"
- .'- 10: **PARTIAL_FAILED (部分失败)**。'."\n"
- .'- 11: **SKIPPED (已跳过)**。'."\n"
- .'- 12: **REMOVED (已移除)**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '4',
- ],
- ],
- [
- 'name' => 'StartTime',
+ 'name' => 'Title',
'in' => 'query',
- 'schema' => [
- 'description' => '开始时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-11-12 20:50:55',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '结束时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-11-12 20:50:56',
- ],
+ 'schema' => ['description' => '标题。', 'type' => 'string', 'required' => false, 'example' => '测试应用'],
],
[
'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '单页数据量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1',
- ],
- 'Message' => [
- 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '错误信息。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'RequestId' => ['description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '查询结果。',
'type' => 'object',
'properties' => [
'Records' => [
- 'title' => '任务实例列表',
- 'description' => '任务实例列表',
'type' => 'array',
'items' => [
- 'title' => '任务实例',
- 'description' => '任务实例',
'type' => 'object',
'properties' => [
- 'JobExecutionId' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'example' => '1310630367761285120',
- ],
- 'JobName' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => 'test-job',
- ],
- 'JobType' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'example' => 'xxljob',
- ],
- 'Parameters' => [
- 'description' => '任务参数。',
- 'type' => 'string',
- 'example' => 'name=zhangsan',
- ],
- 'ScheduleTime' => [
- 'description' => '任务调度时间。',
- 'type' => 'string',
- 'example' => '2024-11-12 14:52:42',
- ],
- 'DataTime' => [
- 'description' => '任务数据时间。',
- 'type' => 'string',
- 'example' => '2024-11-12 14:52:42',
- ],
- 'EndTime' => [
- 'description' => '任务结束时间。',
- 'type' => 'string',
- 'example' => '2024-11-12 14:52:42',
- ],
- 'Executor' => [
- 'description' => '执行者ID。',
- 'type' => 'string',
- 'example' => '1827811800526000',
- ],
- 'Result' => [
- 'description' => '返回结果。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Status' => [
- 'description' => '任务执行状态。具体说明如下：'."\n"
- .'- 0: UNKNOWN (未知)。'."\n"
- .'- 1: WAITING (等待)。'."\n"
- .'- 2: READY (准备就绪)。'."\n"
- .'- 3: RUNNING (运行中)。'."\n"
- .'- 4: SUCCESS (成功)。'."\n"
- .'- 5: FAILED (失败)。'."\n"
- .'- 6: PAUSED (已暂停)。'."\n"
- .'- 7: SUBMITTED (已提交)。'."\n"
- .'- 8: REJECTED (被拒绝)。'."\n"
- .'- 9: ACCEPTED (已接受)。'."\n"
- .'- 10: PARTIAL_FAILED (部分失败)。'."\n"
- .'- 11: SKIPPED (已跳过)。'."\n"
- .'- 12: REMOVED (已移除)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'TimeType' => [
- 'description' => '时间类型：'."\n"
- .'- -1: none<br/>'."\n"
- .'- 1：cron<br/>'."\n"
- .'- 3：fix_rate<br/>'."\n"
- .'- 5：one_time<br/>'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Attempt' => [
- 'description' => '失败尝试次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'WorkAddr' => [
- 'description' => '任务实例的运行机器。',
- 'type' => 'string',
- 'example' => 'http://192.168.1.9:9999/',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'RouteStrategy' => [
- 'description' => '路由策略。具体取值如下：'."\n"
- .'- 1：轮询。'."\n"
- .'- 2：随机。'."\n"
- .'- 3：第一个。'."\n"
- .'- 4：最后一个。'."\n"
- .'- 5：最不经常使用。'."\n"
- .'- 6：最近最久未使用。'."\n"
- .'- 7：一致性哈希。'."\n"
- .'- 8：分片广播。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ServerIp' => [
- 'description' => '调度节点。',
- 'type' => 'string',
- 'example' => '28.0.168.46',
- ],
- 'TriggerType' => [
- 'description' => '任务触发类型。具体说明如下：'."\n"
- .'- 0：unknown。'."\n"
- .'- 1：schedule。'."\n"
- .'- 2：rerun。'."\n"
- .'- 3：api。'."\n"
- .'- 4：user_retry。'."\n"
- .'- 5：system_retry。'."\n"
- .'- 6：manual。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalTokens' => [
- 'title' => 'AI任务消耗的tokens',
- 'description' => 'AI任务消耗的tokens',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'WorkflowName' => [
- 'title' => '工作流名称',
- 'description' => '工作流名称',
- 'type' => 'string',
- 'example' => 'myWorkflow',
- ],
- 'WorkflowExecutionId' => [
- 'title' => '工作流实例ID',
- 'description' => '工作流实例ID',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'JobId' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '74',
- ],
- 'Duration' => [
- 'description' => '运行总时长。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'WorkflowId' => [
- 'title' => '工作流ID',
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
+ 'Id' => ['description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '43885'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ 'AccessToken' => ['description' => 'AccessToken。', 'type' => 'string', 'example' => '2f4ddeab8e344ed68e0402cf9b8502ffv3'],
+ 'Title' => ['description' => '标题。', 'type' => 'string', 'example' => '测试应用'],
+ 'Creator' => ['description' => '创建人。', 'type' => 'string', 'example' => '1827811800555555'],
+ 'Updater' => ['description' => '更新人。', 'type' => 'string', 'example' => '1827811800555555'],
+ 'Leader' => ['description' => 'Leader地址。', 'type' => 'string', 'example' => 'http://28.***.***.3:80'],
+ 'MaxJobs' => ['title' => '该字段废弃', 'description' => '最大任务数。', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'example' => '1000'],
+ 'MaxConcurrency' => ['description' => '最大并发数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'JobNum' => ['description' => '任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'ExecutorNum' => ['description' => '执行器数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'EnableLog' => ['description' => '是否开启日志。'."\n"
+ ."\n"
+ .'- true：开启。'."\n"
+ ."\n"
+ .'- false：关闭。', 'type' => 'boolean', 'example' => 'true'],
+ 'LabelRouteStrategy' => ['type' => 'integer', 'format' => 'int32', 'title' => '标签路由策略', 'example' => '1', 'description' => '标签路由策略'],
+ 'AppType' => ['title' => '应用类型', 'description' => '应用类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WorkerType' => ['title' => 'worker类型', 'type' => 'string', 'example' => 'openclaw'],
+ 'WorkflowNum' => ['title' => '当前工作流数量', 'description' => '当前工作流数量', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '0'],
+ 'WorkerRegistry' => ['title' => '手动注册执行器类型', 'description' => '手动注册执行器类型', 'type' => 'string', 'example' => 'k8s_service', 'deprecated' => false],
+ 'WorkerId' => ['title' => 'worker组ID', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
+ 'description' => '',
],
+ 'description' => '',
],
- 'Total' => [
- 'description' => '数据总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'PageNumber' => [
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Total' => ['title' => '总条数', 'description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
+ 'description' => '',
],
],
],
@@ -8073,52 +4942,40 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"6BCE89B3-E882-511D-9A75-D452A56EC4B1\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"JobExecutionId\\": \\"1310630367761285120\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"JobType\\": \\"xxljob\\",\\n \\"Parameters\\": \\"name=zhangsan\\",\\n \\"ScheduleTime\\": \\"2024-11-12 14:52:42\\",\\n \\"DataTime\\": \\"2024-11-12 14:52:42\\",\\n \\"EndTime\\": \\"2024-11-12 14:52:42\\",\\n \\"Executor\\": \\"1827811800526000\\",\\n \\"Result\\": \\"success\\",\\n \\"Status\\": 4,\\n \\"TimeType\\": 1,\\n \\"Attempt\\": 1,\\n \\"WorkAddr\\": \\"http://192.168.1.9:9999/\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"RouteStrategy\\": 1,\\n \\"ServerIp\\": \\"28.0.168.46\\",\\n \\"TriggerType\\": 1,\\n \\"TotalTokens\\": 1000,\\n \\"WorkflowName\\": \\"myWorkflow\\",\\n \\"WorkflowExecutionId\\": \\"100\\",\\n \\"JobId\\": 74,\\n \\"Duration\\": 10,\\n \\"WorkflowId\\": 10\\n }\\n ],\\n \\"Total\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
- 'title' => '获取任务实例列表',
- ],
- 'ListK8sResource' => [
- 'summary' => '获取k8s资源',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"RequestId\\": \\"2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"Id\\": 43885,\\n \\"AppName\\": \\"test-app\\",\\n \\"AccessToken\\": \\"2f4ddeab8e344ed68e0402cf9b8502ffv3\\",\\n \\"Title\\": \\"测试应用\\",\\n \\"Creator\\": \\"1827811800555555\\",\\n \\"Updater\\": \\"1827811800555555\\",\\n \\"Leader\\": \\"http://28.***.***.3:80\\",\\n \\"MaxJobs\\": 1000,\\n \\"MaxConcurrency\\": 100,\\n \\"JobNum\\": 10,\\n \\"ExecutorNum\\": 1,\\n \\"EnableLog\\": true,\\n \\"LabelRouteStrategy\\": 1,\\n \\"AppType\\": 1,\\n \\"WorkerType\\": \\"openclaw\\",\\n \\"WorkflowNum\\": 3,\\n \\"WorkerRegistry\\": \\"k8s_service\\",\\n \\"WorkerId\\": 1\\n }\\n ],\\n \\"Total\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
+ 'title' => '获取应用列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-25T03:50:37.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApps'],
+ ],
],
+ ],
+ 'ListCalendarNames' => [
+ 'summary' => '获取日历名字列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8127,74 +4984,24 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227444',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'allowEmptyValue' => false,
'schema' => [
'description' => '集群ID。',
'type' => 'string',
'required' => true,
+ 'enumValueTitles' => [],
'example' => 'xxljob-b6ec1xxxx',
],
],
- [
- 'name' => 'K8sClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '同步命名空间的Kubernetes集群ID。Kubernetes集群已添加到ServiceMeshId指定的服务网格中。'."\n"
- .'若查询k8s命名空间或k8s服务时，该字段为必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cadb451ed7af04b0297f4be396a2196fc',
- ],
- ],
- [
- 'name' => 'K8sNamespace',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'k8s集群的命名空间ID。'."\n"
- .'若查询k8s服务时，该字段为必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- ],
- [
- 'name' => 'ResourceType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '资源类型定义。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cluster',
- 'enum' => [
- 'cluster',
- 'namespace',
- 'service',
- ],
- ],
- ],
- [
- 'name' => 'VpcId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'VPC ID。'."\n"
- .'若选择ResourceType值为cluster时，该字段为必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'vpc-aa1a18236n90rqhuhhnhh',
- ],
- ],
],
'responses' => [
200 => [
@@ -8203,49 +5010,16 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '-',
'type' => 'array',
- 'items' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'ResourceName' => [
- 'description' => 'k8s资源名称',
- 'type' => 'string',
- 'example' => 'q_ecs_enterprise_spot_c',
- ],
- 'ResourceId' => [
- 'description' => 'k8s资源ID',
- 'type' => 'string',
- 'example' => 'xxljob-01632622cda2f',
- ],
- ],
- ],
+ 'items' => ['description' => '日历名列表。', 'type' => 'string', 'example' => 'workday'],
+ 'description' => '',
],
],
],
@@ -8253,57 +5027,35 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"workday\\"\\n ]\\n}","type":"json"}]',
+ 'title' => '获取日历名字列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCalendarNames'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"ResourceName\\": \\"q_ecs_enterprise_spot_c\\",\\n \\"ResourceId\\": \\"xxljob-01632622cda2f\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取k8s资源',
- 'description' => '# 引入增强插件'."\n"
- ."\n"
- .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
- ."\n"
- .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
- ."\n"
- .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
],
- 'GetLogEvent' => [
- 'summary' => '查询事件。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListCalendars' => [
+ 'summary' => '获取日历列表',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8315,172 +5067,185 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '228058',
- 'abilityTreeNodes' => [
- 'FEATUREmse8C5258',
- ],
+ 'abilityTreeCode' => '251680',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-684d02ee5a6',
- ],
+ 'schema' => ['title' => '', 'description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'AppName',
+ 'name' => 'CalendarName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxl-job-executor-perf-test-241',
- ],
+ 'schema' => ['description' => '日历名称', 'type' => 'string', 'required' => false, 'example' => 'workday'],
],
[
- 'name' => 'EventType',
+ 'name' => 'Year',
'in' => 'query',
- 'schema' => [
- 'title' => '事件类型',
- 'description' => '事件类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'JOB',
- 'default' => 'JOB',
- 'enum' => [
- 'JOB',
- 'WORKFLOW',
- ],
- ],
+ 'schema' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2024'],
],
[
- 'name' => 'JobName',
+ 'name' => 'FetchCalendarDetail',
'in' => 'query',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => '是否拉取日历明细（默认：false）'."\n"
+ .'- false：不返回每月的详细天列表，只返回基础信息。'."\n"
+ .'- true：返回每月日历详细天列表。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
- 'name' => 'JobExecutionId',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '101',
- ],
+ 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20'],
],
[
- 'name' => 'WorkflowName',
+ 'name' => 'NextToken',
'in' => 'query',
+ 'schema' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '工作流名称',
- 'description' => '工作流名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '流程001',
+ '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' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'description' => '数据列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CalendarName' => ['description' => '日历名称', 'type' => 'string', 'example' => 'workday'],
+ 'Year' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'example' => '2025'],
+ 'Months' => ['description' => '每个月的日历，JSON数组格式', 'type' => 'string', 'example' => '['."\n"
+ .' {"month":1,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
+ .' {"month":2,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
+ .' {"month":3,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},'."\n"
+ .' {"month":4,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},'."\n"
+ .' {"month":5,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},'."\n"
+ .' {"month":6,"days":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},'."\n"
+ .' {"month":7,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},'."\n"
+ .' {"month":8,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},'."\n"
+ .' {"month":9,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},'."\n"
+ .' {"month":10,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
+ .' {"month":11,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
+ .' {"month":12,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}'."\n"
+ .']'],
+ ],
+ ],
+ ],
+ 'NextToken' => ['description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
+ ],
[
- 'name' => 'WorkflowExecutionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作流执行ID',
- 'description' => '工作流执行ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1450568762586578000',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1721268302000',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"CalendarName\\": \\"workday\\",\\n \\"Year\\": 2025,\\n \\"Months\\": \\"[\\\\n {\\\\\\"month\\\\\\":1,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":2,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":3,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},\\\\n {\\\\\\"month\\\\\\":4,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},\\\\n {\\\\\\"month\\\\\\":5,\\\\\\"days\\\\\\":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},\\\\n {\\\\\\"month\\\\\\":6,\\\\\\"days\\\\\\":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},\\\\n {\\\\\\"month\\\\\\":7,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":8,\\\\\\"days\\\\\\":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},\\\\n {\\\\\\"month\\\\\\":9,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},\\\\n {\\\\\\"month\\\\\\":10,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":11,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":12,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}\\\\n]\\"\\n }\\n ],\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\",\\n \\"Total\\": 10,\\n \\"MaxResults\\": 10\\n }\\n}","type":"json"}]',
+ 'title' => '获取日历列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ ],
+ 'ListClusters' => [
+ 'summary' => '查询实例列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'EndTime',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227435',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => '结束时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1721636220',
- ],
+ 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'default' => '1'],
],
[
- 'name' => 'Event',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '事件',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'INFO',
- 'enum' => [],
- ],
+ 'schema' => ['description' => '分页查询时每页的条目数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20'],
],
[
- 'name' => 'Keyword',
+ 'name' => 'Tag',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '关键字',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'Value' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => 'test_partition_tbl',
+ 'maxItems' => 21,
+ 'description' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'xxljob-d6a5243b6fa'],
],
[
- 'name' => 'PageNum',
+ 'name' => 'ClusterName',
'in' => 'query',
- 'schema' => [
- 'description' => '分页的页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '集群名称。', 'type' => 'string', 'required' => false, 'example' => 'cluster-test'],
],
[
- 'name' => 'Reverse',
+ 'name' => 'ClusterType',
'in' => 'query',
- 'schema' => [
- 'description' => '是否降序：'."\n"
- ."\n"
- .' - **true**：按降序排序'."\n"
- .' - **false**：按升序排序',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'true',
- ],
+ 'schema' => ['title' => '集群类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'responses' => [
@@ -8490,116 +5255,74 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589'],
+ 'Message' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '错误信息。', 'type' => 'string', 'required' => true, 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '-',
'type' => 'object',
'properties' => [
'Records' => [
- 'description' => '-',
'type' => 'array',
'items' => [
- 'description' => '-',
'type' => 'object',
'properties' => [
- 'EventType' => [
- 'title' => '事件类型',
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'JOB',
- ],
- 'AppName' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'example' => 'portal-dev',
- ],
- 'JobName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'JobExecutionId' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'example' => '101',
- ],
- 'WorkflowName' => [
- 'title' => '工作流名称',
- 'description' => '工作流名称',
- 'type' => 'string',
- 'example' => '工作流0001',
- ],
- 'WorkflowExecutionId' => [
- 'title' => '工作流执行记录ID',
- 'description' => '工作流执行记录ID',
- 'type' => 'string',
- 'example' => '1450568762586578000',
- ],
- 'Event' => [
- 'description' => '事件ID',
- 'type' => 'string',
- 'example' => 'info',
- ],
- 'WorkerAddr' => [
- 'description' => '机器地址',
- 'type' => 'string',
- 'example' => '030225016025_9357_60125@127.0.0.1:51363',
- ],
- 'Content' => [
- 'description' => '日志内容',
- 'type' => 'string',
- 'example' => 'hello word',
- ],
- 'Time' => [
- 'description' => '打印时间，格式为'."\n"
- .'yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2024-10-31 16:43:51',
+ 'ClusterId' => ['title' => '集群ID', 'description' => '集群ID。', 'type' => 'string', 'example' => 'xxljob-c20f7ec9a78'],
+ 'ClusterName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'xxl-job-test-1730427510169'],
+ 'ClusterSpec' => ['title' => '实例规格', 'description' => '实例规格。', 'type' => 'string', 'example' => 'scx.small.x2'],
+ 'ProductType' => ['title' => '产品版本 1 开发版 2 专业版', 'description' => '产品版本 。'."\n"
+ .'- 1 开发版 。'."\n"
+ .'- 2 专业版 。'."\n"
+ .'- 3 企业版。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'EngineType' => ['title' => '引擎类型', 'description' => '引擎类型。', 'type' => 'string', 'example' => 'xxljob'],
+ 'EngineVersion' => ['title' => '引擎版本', 'description' => '引擎版本。', 'type' => 'string', 'example' => '2.0.0'],
+ 'Status' => ['title' => '运行状态 1. 创建中 2. 运行中 3. 重启中 4. 销毁中 5.创建失败 6.停机', 'description' => '集群状态。'."\n"
+ ."\n"
+ .'- 1：创建中。'."\n"
+ .'- 2：运行中。'."\n"
+ .'- 3：重启中。'."\n"
+ .'- 4：销毁中。'."\n"
+ .'- 5：创建失败。'."\n"
+ .'- 6：停机。'."\n"
+ .'- 99：删除。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-10-29 15:56:36'],
+ 'EndTime' => ['description' => '过期时间。', 'type' => 'string', 'example' => '2024-10-29 15:56:36'],
+ 'IntranetDomain' => ['title' => '访问方式 内网', 'description' => '内网域名。', 'type' => 'string', 'example' => 'http://xxljob-b9e19e46c4e.schedulerx.mse.aliyuncs.com'],
+ 'InternetDomain' => ['title' => '访问方式 公网 ', 'description' => '公网域名。'."\n"
+ .'> 暂不支持', 'type' => 'string', 'example' => '暂无'],
+ 'ChargeType' => ['description' => '付费方式。 取值说明：'."\n"
+ .'- PREPAY：包年包月。'."\n"
+ .'- POSTPAY：按量付费。', 'type' => 'string', 'example' => 'PREPAY'],
+ 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1fxort6ag5h9752i305'],
+ 'VSwitches' => [
+ 'description' => '可用区交换机信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '结果集。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-h'],
+ 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-8vbl54xzux86usy61r5zm'],
+ ],
+ ],
],
+ 'SpInstanceId' => ['description' => '订单资产实例ID。', 'type' => 'string', 'example' => 'mse_schedulerxpost_public_cn-htq402sak02'],
+ 'VersionLifecycle' => ['type' => 'string', 'description' => ''],
+ 'Tags' => ['type' => 'object', 'description' => ''],
+ 'ClusterType' => ['title' => '集群类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Source' => ['title' => '来源', 'type' => 'string'],
],
+ 'description' => '',
],
+ 'description' => '',
],
- 'PageNumber' => [
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '总数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '33',
- ],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
],
+ 'description' => '',
],
],
],
@@ -8607,164 +5330,68 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"EventType\\": \\"JOB\\",\\n \\"AppName\\": \\"portal-dev\\",\\n \\"JobName\\": \\"test\\",\\n \\"JobExecutionId\\": \\"101\\",\\n \\"WorkflowName\\": \\"工作流0001\\",\\n \\"WorkflowExecutionId\\": \\"1450568762586578000\\",\\n \\"Event\\": \\"info\\",\\n \\"WorkerAddr\\": \\"030225016025_9357_60125@127.0.0.1:51363\\",\\n \\"Content\\": \\"hello word\\",\\n \\"Time\\": \\"2024-10-31 16:43:51\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 33\\n }\\n}","type":"json"}]',
- 'title' => '查询事件',
- ],
- 'ImportJobs' => [
- 'summary' => '批量导入任务。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"ClusterId\\": \\"xxljob-c20f7ec9a78\\",\\n \\"ClusterName\\": \\"xxl-job-test-1730427510169\\",\\n \\"ClusterSpec\\": \\"scx.small.x2\\",\\n \\"ProductType\\": 1,\\n \\"EngineType\\": \\"xxljob\\",\\n \\"EngineVersion\\": \\"2.0.0\\",\\n \\"Status\\": 1,\\n \\"CreateTime\\": \\"2024-10-29 15:56:36\\",\\n \\"EndTime\\": \\"2024-10-29 15:56:36\\",\\n \\"IntranetDomain\\": \\"http://xxljob-b9e19e46c4e.schedulerx.mse.aliyuncs.com\\",\\n \\"InternetDomain\\": \\"暂无\\",\\n \\"ChargeType\\": \\"PREPAY\\",\\n \\"VpcId\\": \\"vpc-bp1fxort6ag5h9752i305\\",\\n \\"VSwitches\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VSwitchId\\": \\"vsw-8vbl54xzux86usy61r5zm\\"\\n }\\n ],\\n \\"SpInstanceId\\": \\"mse_schedulerxpost_public_cn-htq402sak02\\",\\n \\"VersionLifecycle\\": \\"\\",\\n \\"Tags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ClusterType\\": 1,\\n \\"Source\\": \\"\\"\\n }\\n ],\\n \\"Total\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50\\n }\\n}","type":"json"}]',
+ 'title' => '查询实例列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-04T09:16:51.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-04-29T06:59:52.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusters'],
+ ],
],
+ ],
+ 'ListContacts' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227422',
- 'abilityTreeNodes' => [
- 'FEATUREmse7UN7CQ',
- ],
+ 'abilityTreeNodes' => ['FEATUREmseFDWH5S'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'Overwrite',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '如果已存在，是否覆盖。默认值为 true。'."\n"
- .'- true：覆盖。'."\n"
- .'- false：不覆盖。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '导入内容。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "kind": "SchedulerXJobs",'."\n"
- .' "type": "JSON",'."\n"
- .' "version": "2.0",'."\n"
- .' "content": ['."\n"
- .' {'."\n"
- .' "appName": "xxl-job-executor-perf-test-xx",'."\n"
- .' "groupId": "xxl-job-executor-perf-test-xx",'."\n"
- .' "description": "xxl-job-executor-xx",'."\n"
- .' "jobConfigInfo": ['."\n"
- .' {'."\n"
- .' "jobHandler": "testJobVoidHandler",'."\n"
- .' "dataOffset": 0,'."\n"
- .' "executeMode": "standalone",'."\n"
- .' "monitorConfigInfo": {'."\n"
- .' "alarmType": "CustomContacts",'."\n"
- .' "failLimitTimes": 1,'."\n"
- .' "failEnable": true,'."\n"
- .' "failRate": 100,'."\n"
- .' "timeoutKillEnable": false,'."\n"
- .' "missWorkerEnable": false,'."\n"
- .' "sendChannel": "webhook",'."\n"
- .' "timeoutEnable": true,'."\n"
- .' "timeout": 7200,'."\n"
- .' "daysOfDeadline": 0,'."\n"
- .' "successNotice": false'."\n"
- .' },'."\n"
- .' "attemptInterval": 30,'."\n"
- .' "cleanMode": "{\\"cleanMode\\":\\"NUM_ONLY\\",\\"totalRemain\\":300}",'."\n"
- .' "description": "",'."\n"
- .' "routeStrategy": 1,'."\n"
- .' "userName": "xx",'."\n"
- .' "userId": "xx",'."\n"
- .' "content": "{\\"jobHandler\\":\\"testJobVoidHandler\\"}",'."\n"
- .' "maxConcurrency": 1,'."\n"
- .' "maxAttempt": 0,'."\n"
- .' "name": "perf_auto_test_0",'."\n"
- .' "xattrs": "",'."\n"
- .' "jobType": "xxljob",'."\n"
- .' "contentType": 1,'."\n"
- .' "parameters": "success-withMsg",'."\n"
- .' "timeConfig": {'."\n"
- .' "calendar": "",'."\n"
- .' "dataOffset": 0,'."\n"
- .' "timeType": 1,'."\n"
- .' "paramMap": {},'."\n"
- .' "timeExpression": "* * * * * ?"'."\n"
- .' },'."\n"
- .' "contactInfoList": [],'."\n"
- .' "status": 0'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}',
- ],
+ 'name' => 'ContactName',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => '报警联系人姓名。', 'type' => 'string', 'required' => false, 'example' => 'Tom'],
],
[
- 'name' => 'AutoCreateApp',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '自动创建应用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
@@ -8774,28 +5401,38 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '工作流版本信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'description' => '数据列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactId' => ['description' => '联系人id', 'type' => 'integer', 'format' => 'int64', 'example' => 'job-85d64bff-50b5-4d02-aa3f-19956b17449d'],
+ 'ContactName' => ['description' => '联系人名称', 'type' => 'string', 'example' => 'Tom'],
+ 'Type' => ['description' => '创建的联系人的类型'."\n"
+ .'- IM', 'type' => 'string', 'example' => 'IM'],
+ 'Config' => ['description' => '渠道参数配置 JSON 字符串。IM 类型示例：{"channels":[{"channelType":"dingtalk","clientId":"xxx","clientSecret":"xxx","targetType":"group","targetId":"xxx","robotCode":"xxx"}]}', 'type' => 'string', 'example' => '{"channels":[{"channelType":"dingtalk","clientId":"xxx","clientSecret":"xxx","targetType":"group","targetId":"xxx","robotCode":"xxx"}]}'],
+ 'Enabled' => ['description' => '是否开启所选的自定义联系人通知渠道', 'type' => 'boolean', 'example' => 'false'],
+ 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '1783065190000'],
+ 'GmtModified' => ['description' => '修改时间 ', 'type' => 'string', 'example' => '1783065190000'],
+ ],
+ ],
+ ],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '21'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
],
],
],
@@ -8803,51 +5440,33 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
- ],
- [
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查看联系人',
+ 'summary' => '查询通知联系人列表',
+ 'description' => '查看联系人',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E\\",\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '批量导入任务',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"ContactId\\": 0,\\n \\"ContactName\\": \\"Tom\\",\\n \\"Type\\": \\"IM\\",\\n \\"Config\\": \\"{\\\\\\"channels\\\\\\":[{\\\\\\"channelType\\\\\\":\\\\\\"dingtalk\\\\\\",\\\\\\"clientId\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"clientSecret\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"targetType\\\\\\":\\\\\\"group\\\\\\",\\\\\\"targetId\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"robotCode\\\\\\":\\\\\\"xxx\\\\\\"}]}\\",\\n \\"Enabled\\": false,\\n \\"GmtCreate\\": \\"1783065190000\\",\\n \\"GmtModified\\": \\"1783065190000\\"\\n }\\n ],\\n \\"Total\\": 21,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
],
- 'ListRegions' => [
- 'summary' => '获取所有region列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListDatasources' => [
+ 'summary' => '获取数据源列表',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8856,67 +5475,90 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '227434',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '页数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => '修正券统计数据'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Grafana大盘类型，包括：dash-db：大盘 dash-folder：文件夹（可包含大盘）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'REDIS'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Regions' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RegionEndpoint' => [
- 'title' => 'endpoint',
- 'description' => '地域服务的Endpoint。',
- 'type' => 'string',
- 'example' => 'schedulerx3.cn-hangzhou.aliyuncs.com',
- ],
- 'LocalName' => [
- 'title' => '本地名',
- 'description' => '本地名。',
- 'type' => 'string',
- 'example' => 'China (Hangzhou)',
- ],
- 'RegionId' => [
- 'title' => '地区ID',
- 'description' => '地区ID。',
- 'type' => 'string',
- 'example' => 'cn-hangzhou',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'description' => '-',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatasourceId' => ['description' => '数据源ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '145'],
+ 'Name' => ['description' => '任务名', 'type' => 'string', 'example' => 'job01'],
+ 'Description' => ['description' => '任务描述。', 'type' => 'string', 'example' => 'my first workflow'],
+ 'ConnectionParams' => ['description' => '数据源连接参数', 'type' => 'string', 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}'],
+ 'Updater' => ['description' => '更新者。', 'type' => 'string', 'example' => '1827811800555555'],
+ 'Type' => ['description' => '具体发音规则类型。 可选：'."\n"
+ ."\n"
+ .'- replacement。直接将Word替换为Pronunciation的规则。', 'type' => 'integer', 'format' => 'int32', 'example' => 'target'],
+ ],
],
],
+ 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
],
],
@@ -8925,48 +5567,32 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"AFD5B166-4A7D-50DF-91BF-EFAFD41F7335\\",\\n \\"Success\\": true,\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"schedulerx3.cn-hangzhou.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取Region列表',
- ],
- 'ListRegionZone' => [
- 'summary' => '获取可用区列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取数据源列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"DatasourceId\\": 145,\\n \\"Name\\": \\"job01\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"ConnectionParams\\": \\"{\\\\\\"host\\\\\\":\\\\\\"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com\\\\\\",\\\\\\"port\\\\\\":3306,\\\\\\"userName\\\\\\":\\\\\\"test01\\\\\\",\\\\\\"database\\\\\\":\\\\\\"test01\\\\\\",\\\\\\"other\\\\\\":{\\\\\\"useSSL\\\\\\":\\\\\\"false\\\\\\"}}\\",\\n \\"Updater\\": \\"1827811800555555\\",\\n \\"Type\\": 0\\n }\\n ],\\n \\"Total\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ListExecutorGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8978,125 +5604,145 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '231656',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
+ 'abilityTreeNodes' => ['FEATUREmse09FNQO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '执行器组名称', 'type' => 'string', 'required' => false, 'example' => 'group1'],
+ ],
+ [
+ 'name' => 'WorkerType',
+ 'in' => 'query',
+ 'schema' => ['description' => '执行器类型', 'type' => 'string', 'required' => false, 'example' => 'openclaw'],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '页数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'JSONResult',
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
+ 'Code' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Message' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'type' => 'string', 'required' => true, 'example' => 'Parameter check error'."\n"],
+ 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'title' => '返回数据',
- 'description' => '返回数据。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ZoneId' => [
- 'title' => 'zone id',
- 'description' => '可用区ID。',
- 'type' => 'string',
- 'example' => 'cn-beijing-j',
- ],
- 'LocalName' => [
- 'title' => '本地名',
- 'description' => '本地名。',
- 'type' => 'string',
- 'example' => 'E',
+ 'description' => '查询结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'description' => '-',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务实例',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkerId' => ['description' => '执行器组ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'Name' => ['description' => '执行器组名称', 'type' => 'string', 'example' => 'job01'],
+ 'Description' => ['description' => '执行器组描述', 'type' => 'string', 'example' => 'my first workflow'],
+ 'WorkerType' => ['description' => '执行器类型', 'type' => 'string', 'example' => 'k8s_service'],
+ 'CiteList' => [
+ 'description' => '被引用的app列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AppName' => ['description' => '应用名称', 'type' => 'string', 'example' => 'Tornado'],
+ 'Description' => ['description' => '应用描述', 'type' => 'string', 'example' => 'group1'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Network' => ['description' => '网络配置', 'type' => 'string', 'example' => 'public'],
+ 'AuthType' => ['description' => '认证类型', 'type' => 'string', 'example' => 'api_key'],
+ 'ApiKey' => ['description' => '客户端密钥。', 'type' => 'string', 'example' => 'f/HElmWgOgmb0mlbRRkNuQ=='],
+ 'Protocol' => ['description' => '协议', 'type' => 'string', 'example' => 'openai'],
+ 'Workers' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'example' => '[{"address":"http://47.111.188.191:18789"}]'],
+ 'ResolvedWorkers' => ['type' => 'string'],
+ 'IntegrationType' => ['type' => 'string'],
+ 'CmsWorkspaceId' => ['type' => 'string'],
+ 'AutoScale' => ['type' => 'boolean'],
+ 'XAttrs' => ['type' => 'string'],
+ 'CurrentJobs' => ['type' => 'integer', 'format' => 'int32'],
+ 'MaxJobs' => ['type' => 'integer', 'format' => 'int32'],
+ ],
],
],
+ 'Total' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
- 'Code' => [
- 'title' => 'code',
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'IllegalRequest',
- ],
- 'Success' => [
- 'title' => '是否成功(前端要使用)',
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识。',
- 'type' => 'string',
- 'example' => '438737AC-760A-57D9-B646-B7EF79426243',
- ],
+ 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取执行器组列表',
+ 'summary' => '获取执行器组列表',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-j\\",\\n \\"LocalName\\": \\"E\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"IllegalRequest\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"438737AC-760A-57D9-B646-B7EF79426243\\"\\n}","type":"json"}]',
- 'title' => '获取可用区列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Message\\": \\"Parameter check error\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"WorkerId\\": 12,\\n \\"Name\\": \\"job01\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"WorkerType\\": \\"k8s_service\\",\\n \\"CiteList\\": [\\n {\\n \\"AppName\\": \\"Tornado\\",\\n \\"Description\\": \\"group1\\"\\n }\\n ],\\n \\"Network\\": \\"public\\",\\n \\"AuthType\\": \\"api_key\\",\\n \\"ApiKey\\": \\"f/HElmWgOgmb0mlbRRkNuQ==\\",\\n \\"Protocol\\": \\"openai\\",\\n \\"Workers\\": \\"[{\\\\\\"address\\\\\\":\\\\\\"http://47.111.188.191:18789\\\\\\"}]\\",\\n \\"ResolvedWorkers\\": \\"\\",\\n \\"IntegrationType\\": \\"\\",\\n \\"CmsWorkspaceId\\": \\"\\",\\n \\"AutoScale\\": true,\\n \\"XAttrs\\": \\"\\",\\n \\"CurrentJobs\\": 0,\\n \\"MaxJobs\\": 0\\n }\\n ],\\n \\"Total\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\"\\n}","type":"json"}]',
],
- 'ListCalendarNames' => [
- 'summary' => '获取日历名字列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListExecutors' => [
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9108,22 +5754,29 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227444',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeCode' => '227430',
+ 'abilityTreeNodes' => ['FEATUREmseWGXOHM'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74'],
+ ],
+ [
+ 'name' => 'Label',
+ 'in' => 'query',
+ 'schema' => ['description' => '标签。', 'type' => 'string', 'required' => false, 'example' => 'gray'],
],
],
'responses' => [
@@ -9133,36 +5786,30 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'type' => 'array',
'items' => [
- 'description' => '日历名列表。',
- 'type' => 'string',
- 'example' => 'workday',
+ 'type' => 'object',
+ 'properties' => [
+ 'Address' => ['description' => '机器地址。', 'type' => 'string', 'example' => 'http://192.168.1.10:9999/'],
+ 'Ip' => ['description' => '机器IP。', 'type' => 'string', 'example' => '192.168.1.10'],
+ 'Port' => ['description' => '端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => '9999'],
+ 'Label' => ['description' => '标签。', 'type' => 'string', 'example' => 'gray'],
+ 'Version' => ['description' => '版本号。', 'type' => 'string', 'example' => '2.0.2'],
+ 'Online' => ['description' => '客户端是否在线。', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'],
+ 'IsDesignated' => ['description' => '是否指定。', 'type' => 'boolean', 'example' => 'true'],
+ 'Weight' => ['title' => '任务权重', 'description' => '任务权重', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Status' => ['type' => 'string'],
+ ],
+ 'description' => '',
],
+ 'description' => '',
],
],
],
@@ -9170,50 +5817,38 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"workday\\"\\n ]\\n}","type":"json"}]',
- 'title' => '获取日历名字列表',
- ],
- 'ListScheduleEvent' => [
- 'summary' => '查询调度事件。',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询Executor列表',
+ 'summary' => '查询Executor列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExecutors'],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Address\\": \\"http://192.168.1.10:9999/\\",\\n \\"Ip\\": \\"192.168.1.10\\",\\n \\"Port\\": 9999,\\n \\"Label\\": \\"gray\\",\\n \\"Version\\": \\"2.0.2\\",\\n \\"Online\\": true,\\n \\"IsDesignated\\": true,\\n \\"Weight\\": 1,\\n \\"Status\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListJobExecutions' => [
+ 'summary' => '获取任务实例列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9222,599 +5857,495 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '253606',
- 'abilityTreeNodes' => [
- 'FEATUREmse8C5258',
- ],
+ 'abilityTreeCode' => '227441',
+ 'abilityTreeNodes' => ['FEATUREmseWGXOHM'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
- ],
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
],
[
- 'name' => 'JobName',
+ 'name' => 'WorkflowExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-job',
- ],
+ 'schema' => ['title' => '工作流实例ID', 'description' => '工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
- 'name' => 'JobExecutionId',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74'],
],
[
- 'name' => 'WorkflowName',
+ 'name' => 'JobName',
'in' => 'query',
- 'schema' => [
- 'title' => '工作流名称',
- 'description' => '工作流名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '流程001',
- ],
+ 'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'test-job'],
],
[
- 'name' => 'WorkflowExecutionId',
+ 'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'title' => '工作流执行ID',
- 'description' => '工作流执行ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1450568762586578000',
- ],
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行状态。具体说明如下：'."\n"
+ .'- 0: **UNKNOWN (未知)**。'."\n"
+ .'- 1: **WAITING (等待)**。'."\n"
+ .'- 2: **READY (准备就绪)**。'."\n"
+ .'- 3: **RUNNING (运行中)**。'."\n"
+ .'- 4: **SUCCESS (成功)**。'."\n"
+ .'- 5: **FAILED (失败)**。'."\n"
+ .'- 6: **PAUSED (已暂停)**。'."\n"
+ .'- 7: **SUBMITTED (已提交)**。'."\n"
+ .'- 8: **REJECTED (被拒绝)**。'."\n"
+ .'- 9: **ACCEPTED (已接受)**。'."\n"
+ .'- 10: **PARTIAL_FAILED (部分失败)**。'."\n"
+ .'- 11: **SKIPPED (已跳过)**。'."\n"
+ .'- 12: **REMOVED (已移除)**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '检索到事件的开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1581317873000',
- ],
+ 'schema' => ['description' => '开始时间。', 'type' => 'string', 'required' => false, 'example' => '2024-11-12 20:50:55'],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '检索到事件的结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1728872796295',
- ],
+ 'schema' => ['description' => '结束时间。', 'type' => 'string', 'required' => false, 'example' => '2024-11-12 20:50:56'],
],
[
- 'name' => 'Event',
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => '事件ID。具体类型如下：'."\n"
- .'- Scheduled。'."\n"
- .'- Running。'."\n"
- .'- Succeed。'."\n"
- .'- Failed。'."\n"
- .'- Failing_Auto_Retry。'."\n"
- .'- Skip_Schedule。'."\n"
- .'- Execute_Log。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Failed',
- ],
+ 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'EventType',
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['description' => '单页数据量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '事件类型',
- 'description' => '事件类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'JOB | WORKFLOW',
- 'default' => 'JOB',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1'],
+ 'Message' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '错误信息。', 'type' => 'string', 'required' => true, 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '查询结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'title' => '任务实例列表',
+ 'description' => '任务实例列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '任务实例',
+ 'description' => '任务实例',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobExecutionId' => ['description' => '任务执行ID。', 'type' => 'string', 'example' => '1310630367761285120'],
+ 'JobName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'test-job'],
+ 'JobType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'xxljob'],
+ 'Parameters' => ['description' => '任务参数。', 'type' => 'string', 'example' => 'name=zhangsan'],
+ 'ScheduleTime' => ['description' => '任务调度时间。', 'type' => 'string', 'example' => '2024-11-12 14:52:42'],
+ 'DataTime' => ['description' => '任务数据时间。', 'type' => 'string', 'example' => '2024-11-12 14:52:42'],
+ 'EndTime' => ['description' => '任务结束时间。', 'type' => 'string', 'example' => '2024-11-12 14:52:42'],
+ 'Executor' => ['description' => '执行者ID。', 'type' => 'string', 'example' => '1827811800526000'],
+ 'Result' => ['description' => '返回结果。', 'type' => 'string', 'example' => 'success'],
+ 'Status' => ['description' => '任务执行状态。具体说明如下：'."\n"
+ .'- 0: UNKNOWN (未知)。'."\n"
+ .'- 1: WAITING (等待)。'."\n"
+ .'- 2: READY (准备就绪)。'."\n"
+ .'- 3: RUNNING (运行中)。'."\n"
+ .'- 4: SUCCESS (成功)。'."\n"
+ .'- 5: FAILED (失败)。'."\n"
+ .'- 6: PAUSED (已暂停)。'."\n"
+ .'- 7: SUBMITTED (已提交)。'."\n"
+ .'- 8: REJECTED (被拒绝)。'."\n"
+ .'- 9: ACCEPTED (已接受)。'."\n"
+ .'- 10: PARTIAL_FAILED (部分失败)。'."\n"
+ .'- 11: SKIPPED (已跳过)。'."\n"
+ .'- 12: REMOVED (已移除)。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'TimeType' => ['description' => '时间类型：'."\n"
+ .'- -1: none<br/>'."\n"
+ .'- 1：cron<br/>'."\n"
+ .'- 3：fix_rate<br/>'."\n"
+ .'- 5：one_time<br/>'."\n"
+ .'- 100:：api', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Attempt' => ['description' => '失败尝试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WorkAddr' => ['description' => '任务实例的运行机器。', 'type' => 'string', 'example' => 'http://192.168.1.9:9999/'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ 'RouteStrategy' => ['description' => '路由策略。具体取值如下：'."\n"
+ .'- 1：轮询。'."\n"
+ .'- 2：随机。'."\n"
+ .'- 3：第一个。'."\n"
+ .'- 4：最后一个。'."\n"
+ .'- 5：最不经常使用。'."\n"
+ .'- 6：最近最久未使用。'."\n"
+ .'- 7：一致性哈希。'."\n"
+ .'- 8：分片广播。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ServerIp' => ['description' => '调度节点。', 'type' => 'string', 'example' => '28.0.168.46'],
+ 'TriggerType' => ['description' => '任务触发类型。具体说明如下：'."\n"
+ .'- 0：unknown。'."\n"
+ .'- 1：schedule。'."\n"
+ .'- 2：rerun。'."\n"
+ .'- 3：api。'."\n"
+ .'- 4：user_retry。'."\n"
+ .'- 5：system_retry。'."\n"
+ .'- 6：manual。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalTokens' => ['title' => 'AI任务消耗的tokens', 'description' => 'AI任务消耗的tokens', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'WorkflowName' => ['title' => '工作流名称', 'description' => '工作流名称', 'type' => 'string', 'example' => 'myWorkflow'],
+ 'WorkflowExecutionId' => ['title' => '工作流实例ID', 'description' => '工作流实例ID', 'type' => 'string', 'example' => '100'],
+ 'JobId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '74'],
+ 'Duration' => ['description' => '运行总时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'WorkflowId' => ['title' => '工作流ID', 'description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'XAttrs' => ['title' => '任务执行扩展属性', 'type' => 'string', 'example' => '{"sessionId":"ac21f9f6-5a88-4f97-abd1-b51989166035"}'],
+ ],
+ ],
+ ],
+ 'Total' => ['description' => '数据总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'PageNumber' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
+ ],
[
- 'name' => 'Keyword',
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
+ ],
+ [
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取任务实例列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-05-20T09:00:54.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobExecutions'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"6BCE89B3-E882-511D-9A75-D452A56EC4B1\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"JobExecutionId\\": \\"1310630367761285120\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"JobType\\": \\"xxljob\\",\\n \\"Parameters\\": \\"name=zhangsan\\",\\n \\"ScheduleTime\\": \\"2024-11-12 14:52:42\\",\\n \\"DataTime\\": \\"2024-11-12 14:52:42\\",\\n \\"EndTime\\": \\"2024-11-12 14:52:42\\",\\n \\"Executor\\": \\"1827811800526000\\",\\n \\"Result\\": \\"success\\",\\n \\"Status\\": 4,\\n \\"TimeType\\": 1,\\n \\"Attempt\\": 1,\\n \\"WorkAddr\\": \\"http://192.168.1.9:9999/\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"RouteStrategy\\": 1,\\n \\"ServerIp\\": \\"28.0.168.46\\",\\n \\"TriggerType\\": 1,\\n \\"TotalTokens\\": 1000,\\n \\"WorkflowName\\": \\"myWorkflow\\",\\n \\"WorkflowExecutionId\\": \\"100\\",\\n \\"JobId\\": 74,\\n \\"Duration\\": 10,\\n \\"WorkflowId\\": 10,\\n \\"XAttrs\\": \\"{\\\\\\"sessionId\\\\\\":\\\\\\"ac21f9f6-5a88-4f97-abd1-b51989166035\\\\\\"}\\"\\n }\\n ],\\n \\"Total\\": 20,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
+ ],
+ 'ListJobScriptHistory' => [
+ 'summary' => '获取任务脚本历史列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227441',
+ 'abilityTreeNodes' => ['FEATUREmseWGXOHM'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '查询关键字。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hello word',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'allowEmptyValue' => true,
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'PageNum',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74'],
],
[
- 'name' => 'Reverse',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '是否降序。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '-',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'B880122A-B0E4-52E8-8F54-87DB7779EB74',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Message' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '错误信息。', 'type' => 'string', 'required' => true, 'example' => 'not support query script history, please upgrade engine version to 2.2.2+'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
+ 'description' => '-',
'type' => 'object',
'properties' => [
'Records' => [
- 'description' => '结果集。',
+ 'description' => '-',
'type' => 'array',
'items' => [
- 'description' => '单行数据。',
+ 'description' => '-',
'type' => 'object',
'properties' => [
- 'EventType' => [
- 'title' => '事件类型',
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'JOB',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'JobName' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => 'test-job',
- ],
- 'JobExecutionId' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'example' => '1310630367761285120',
- ],
- 'WorkflowName' => [
- 'title' => '工作流名称',
- 'description' => '工作流名称',
- 'type' => 'string',
- 'example' => '工作流0001',
- ],
- 'WorkflowExecutionId' => [
- 'title' => '工作流执行记录ID',
- 'description' => '工作流执行记录ID',
- 'type' => 'string',
- 'example' => '1450568762586578000',
- ],
- 'Event' => [
- 'description' => '事件ID。',
- 'type' => 'string',
- 'example' => 'Failed',
- ],
- 'WorkerAddr' => [
- 'description' => '机器地址。',
- 'type' => 'string',
- 'example' => 'http://192.168.1.5:9999/',
- ],
- 'Content' => [
- 'description' => '内容。',
- 'type' => 'string',
- 'example' => 'hello word'."\n",
- ],
- 'Time' => [
- 'description' => '打印时间，格式为`yyyy-MM-dd HH:mm:ss`。',
- 'type' => 'string',
- 'example' => '2024-10-31 16:43:51'."\n",
- ],
+ 'VersionDescription' => ['description' => '脚本版本描述。', 'type' => 'string', 'example' => 'init version'],
+ 'ScriptContent' => ['description' => '脚本内容。', 'type' => 'string', 'example' => '#!/bin/bash'."\n"
+ .'echo "xxl-job: hello shell"'."\n"
+ ."\n"
+ .'echo "脚本位置: $0"'."\n"
+ .'echo "任务参数: $1"'."\n"
+ .'echo "分片序号 = $2"'."\n"
+ .'echo "分片总数 = $3"'."\n"
+ ."\n"
+ .'echo "Good bye!"'."\n"
+ .'exit 0'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-06-29 15:56:36'],
+ 'Creator' => ['description' => '创建人。', 'type' => 'string', 'example' => '1963096506470832'],
],
],
],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
+ 'NextToken' => ['description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
+ 'Total' => ['description' => '总条数。', 'type' => 'string', 'example' => '21'],
],
],
+ 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B880122A-B0E4-52E8-8F54-87DB7779EB74\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"EventType\\": \\"JOB\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"JobExecutionId\\": \\"1310630367761285120\\",\\n \\"WorkflowName\\": \\"工作流0001\\",\\n \\"WorkflowExecutionId\\": \\"1450568762586578000\\",\\n \\"Event\\": \\"Failed\\",\\n \\"WorkerAddr\\": \\"http://192.168.1.5:9999/\\",\\n \\"Content\\": \\"hello word\\\\n\\",\\n \\"Time\\": \\"2024-10-31 16:43:51\\\\n\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100\\n }\\n}","type":"json"}]',
- 'title' => '查询调度事件',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"VersionDescription\\": \\"init version\\",\\n \\"ScriptContent\\": \\"#!/bin/bash\\\\necho \\\\\\"xxl-job: hello shell\\\\\\"\\\\n\\\\necho \\\\\\"脚本位置: $0\\\\\\"\\\\necho \\\\\\"任务参数: $1\\\\\\"\\\\necho \\\\\\"分片序号 = $2\\\\\\"\\\\necho \\\\\\"分片总数 = $3\\\\\\"\\\\n\\\\necho \\\\\\"Good bye!\\\\\\"\\\\nexit 0\\",\\n \\"CreateTime\\": \\"2025-06-29 15:56:36\\",\\n \\"Creator\\": \\"1963096506470832\\"\\n }\\n ],\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\",\\n \\"Total\\": \\"21\\"\\n },\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
+ 'title' => '获取任务脚本历史列表',
+ 'changeSet' => [],
],
- 'ListAlarmEvent' => [
- 'summary' => '获取报警事件。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListJobs' => [
+ 'summary' => '获取任务列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '253617',
- 'abilityTreeNodes' => [
- 'FEATUREmse8C5258',
- ],
+ 'abilityTreeCode' => '227452',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test-app'],
],
[
- 'name' => 'JobName',
+ 'name' => 'Status',
'in' => 'query',
- 'schema' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-job',
- ],
+ 'schema' => ['description' => '状态。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => '检索到事件的开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1690419316000',
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'JobName',
'in' => 'query',
- 'schema' => [
- 'description' => '检索到事件的结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1731636011558',
- ],
+ 'schema' => ['description' => '任务名。', 'type' => 'string', 'required' => false, 'example' => 'job01'],
],
[
- 'name' => 'AlarmType',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '报警类型。具体说明如下：'."\n"
- .'- **`schedulerx3_no_designate_machine_alarm`**（指定机器不可用报警）。'."\n"
- .'- **`schedulerx3_all_busy_alarm`**（所有机器繁忙报警）。'."\n"
- .'- **`schedulerx3_no_machine_alarm`**（无可用机器报警）。'."\n"
- .'- **`schedulerx3_timeout_alarm`**（任务超时报警）。'."\n"
- .'- **`schedulerx3_fail_alarm`**（任务执行失败报警）。'."\n"
- .'- **`schedulerx3_job_success_notice`**（任务执行成功）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'schedulerx3_fail_alarm',
- ],
+ 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'job01单机任务'],
],
[
- 'name' => 'AlarmChannel',
+ 'name' => 'JobHandler',
'in' => 'query',
- 'schema' => [
- 'description' => '报警渠道。具体说明如下：'."\n"
- .'- `sms` （短信）。'."\n"
- .'- `mail` （邮箱）。'."\n"
- .'- `phone`（电话）。'."\n"
- .'- `webhook`（webhook）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'webhook',
- ],
+ 'schema' => ['description' => '`jobhandler`名称。', 'type' => 'string', 'required' => false, 'example' => 'jobDemoHandler'],
],
[
- 'name' => 'AlarmStatus',
+ 'name' => 'PageNum',
'in' => 'query',
- 'schema' => [
- 'description' => '报警状态。具体说明如下：'."\n"
- ."\n"
- .'- `true`：报警信息发送成功。'."\n"
- ."\n"
- .'- `false`：报警信息发送失败。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '分页大小。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'schema' => ['description' => '每页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'],
],
[
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'Reverse',
+ 'name' => 'WorkflowId',
'in' => 'query',
- 'schema' => [
- 'description' => '是否降序。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['title' => '工作流ID', 'description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题', 'type' => 'string', 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
+ 'description' => '-',
'type' => 'object',
'properties' => [
'Records' => [
- 'description' => '结果集。',
+ 'description' => '-',
'type' => 'array',
'items' => [
- 'description' => '数据列表。',
+ 'description' => '-',
'type' => 'object',
'properties' => [
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'JobName' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => 'test-job',
- ],
- 'AlarmType' => [
- 'description' => '报警类型。',
- 'type' => 'string',
- 'example' => 'schedulerx3_fail_alarm',
- ],
- 'AlarmChannel' => [
- 'description' => '报警渠道。',
- 'type' => 'string',
- 'example' => 'webhook',
- ],
- 'AlarmContacts' => [
- 'description' => '报警联系人。',
- 'type' => 'string',
- 'example' => 'zhangsan',
- ],
- 'AlarmStatus' => [
- 'description' => '报警状态。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'AlarmMessage' => [
- 'description' => '报警信息。',
- 'type' => 'string',
- 'example' => '报警类型：任务执行失败报警'."\n"
- .'运行环境：cn-xx'."\n"
- .'集群：xxljob-b6ec1acfb2c'."\n"
- .'应用名：testApp'."\n"
- .'任务ID及名称：8(failedjob)'."\n"
- .'实例ID：1308'."\n"
- .'触发时间：2024-11-19 13:57:10'."\n"
- .'失败次数：187'."\n"
- .'运行机器：http://192.***.***.5:9999/'."\n"
- .'失败原因：java.lang.reflect.InvocationTargetException',
- ],
- 'Time' => [
- 'description' => '格式为`yyyy-MM-dd HH:mm:ss`。',
- 'type' => 'string',
- 'example' => '2024-10-31 16:43:51'."\n",
- ],
+ 'JobId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '74'],
+ 'Name' => ['description' => '任务名。', 'type' => 'string', 'example' => 'job01'],
+ 'Description' => ['description' => '任务描述。', 'type' => 'string', 'example' => 'job01单机任务'],
+ 'JobType' => ['description' => '任务类型。', 'type' => 'string', 'example' => 'xxljob'],
+ 'Status' => ['description' => '任务状态。具体取值如下：'."\n"
+ .'- 0：DISABLE (禁用)。'."\n"
+ .'- 1：ENABLE (启用)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Parameters' => ['description' => '任务参数。', 'type' => 'string', 'example' => 'name=10'],
+ 'MaxConcurrency' => ['description' => '总体并发数阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'MaxAttempt' => ['description' => '错误最大重试次数，根据业务需求填写。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'AttemptInterval' => ['description' => '错误重试间隔，单位`s`。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'JobHandler' => ['description' => '`jobhandler`名称。', 'type' => 'string', 'example' => 'jobDemoHandler'],
+ 'Priority' => ['description' => '执行作业优先级。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TimeType' => ['description' => '时间类型，目前支持以下几种类型：'."\n"
+ ."\n"
+ .'- -1：none。'."\n"
+ .'- 1：cron。'."\n"
+ .'- 3：fix_rate。'."\n"
+ .'- 5：one_time。'."\n"
+ .'- 100：api。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TimeExpression' => ['description' => '时间表达式。', 'type' => 'string', 'example' => '0 0 12 * * ?'],
+ 'TimeZone' => ['description' => '时区。', 'type' => 'string', 'example' => 'Hongkong'],
+ 'Calendar' => ['description' => '日历。', 'type' => 'string', 'example' => 'work-day'],
+ 'DataOffset' => ['description' => '数据偏移。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'CleanMode' => ['description' => '清理模式。', 'type' => 'string', 'example' => '{"cleanMode":"NUM_ONLY","totalRemain":300}'],
+ 'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => '1963096506470832'],
+ 'Updater' => ['description' => '更新者。', 'type' => 'string', 'example' => '1963096506470832'],
+ 'Xattrs' => ['description' => '扩展属性。'."\n"
+ .'> 暂不支持', 'type' => 'string', 'example' => '暂无'],
+ 'NoticeConfig' => ['description' => '`Notice`配置。', 'type' => 'string', 'example' => '{"failLimitTimes":1,"failEnable":true,"timeoutKillEnable":false,"missWorkerEnable":true,"timeoutEnable":true,"sendChannel":"","timeout":300,"successNotice":false}'],
+ 'NoticeContacts' => ['description' => '通知联系人。', 'type' => 'string', 'example' => '[{"contactType":1,"name":"恰橙"}]'],
+ 'RouteStrategy' => ['description' => '路由策略：'."\n"
+ .'- 1：轮询。'."\n"
+ .'- 2：随机。'."\n"
+ .'- 3：第一个。'."\n"
+ .'- 4：最后一个。'."\n"
+ .'- 5：最不经常使用。'."\n"
+ .'- 6：最近最久未使用。'."\n"
+ .'- 7：一致性哈希。'."\n"
+ .'- 8：分片广播。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'AppName' => ['description' => '应用名。', 'type' => 'string', 'example' => 'test-app'],
+ 'Timezone' => ['description' => '时区。', 'type' => 'string', 'example' => 'HangKong'],
+ 'LastExecuteEndTime' => ['description' => '上一次执行结束时间。', 'type' => 'string', 'example' => '2025-06-29 15:56:36'."\n"],
+ 'LastExecuteStatus' => ['description' => '上一次的执行结果。'."\n"
+ .'- 4: 成功'."\n"
+ .'- 5: 失败', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'CurrentExecuteStatus' => [
+ 'description' => '当前执行状态：'."\n"
+ .'- 0：未开始。'."\n"
+ .'- 1：运行中。'."\n"
+ .'- 2：队列中。'."\n"
+ .'- 3：等待中。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ 'enum' => ['0', '1', '2', '3'],
+ ],
+ 'ChildJobId' => ['description' => '子任务ID。', 'type' => 'string', 'example' => '1246'],
+ 'Weight' => ['title' => '任务权重', 'description' => '任务权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NodeType' => ['title' => '节点类型', 'description' => '节点类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'DependentStrategy' => ['title' => '依赖检查策略', 'description' => '依赖检查策略', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Script' => ['description' => '脚本内容。', 'type' => 'string', 'example' => '#!/bin/bash'."\n"
+ .'echo "xxl-job: hello shell"'."\n"
+ .'echo "Good bye!"'."\n"
+ .'exit 0'],
+ 'WorkflowId' => ['title' => '工作流ID', 'description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'ExecutorBlockStrategy' => ['description' => '客户端阻塞处理策略。'."\n"
+ .'- 1: 单机串行'."\n"
+ .'- 2: 忽略后续调度'."\n"
+ .'- 3: 覆盖之前调度', 'type' => 'string', 'example' => '1'],
+ 'StartTimeType' => ['title' => '开始时间类型', 'description' => '开始时间类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '64',
- ],
+ 'Total' => ['title' => '任务扩展属性配置信息', 'description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '65'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
@@ -9823,50 +6354,36 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"1DF6732E-15D8-5E1F-95E3-C10077F556B5\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"JobId\\": 74,\\n \\"Name\\": \\"job01\\",\\n \\"Description\\": \\"job01单机任务\\",\\n \\"JobType\\": \\"xxljob\\",\\n \\"Status\\": 1,\\n \\"Parameters\\": \\"name=10\\",\\n \\"MaxConcurrency\\": 100,\\n \\"MaxAttempt\\": 5,\\n \\"AttemptInterval\\": 30,\\n \\"JobHandler\\": \\"jobDemoHandler\\",\\n \\"Priority\\": 1,\\n \\"TimeType\\": 1,\\n \\"TimeExpression\\": \\"0 0 12 * * ?\\",\\n \\"TimeZone\\": \\"Hongkong\\",\\n \\"Calendar\\": \\"work-day\\",\\n \\"DataOffset\\": 3,\\n \\"CleanMode\\": \\"{\\\\\\"cleanMode\\\\\\":\\\\\\"NUM_ONLY\\\\\\",\\\\\\"totalRemain\\\\\\":300}\\",\\n \\"Creator\\": \\"1963096506470832\\",\\n \\"Updater\\": \\"1963096506470832\\",\\n \\"Xattrs\\": \\"暂无\\",\\n \\"NoticeConfig\\": \\"{\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failEnable\\\\\\":true,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"timeout\\\\\\":300,\\\\\\"successNotice\\\\\\":false}\\",\\n \\"NoticeContacts\\": \\"[{\\\\\\"contactType\\\\\\":1,\\\\\\"name\\\\\\":\\\\\\"恰橙\\\\\\"}]\\",\\n \\"RouteStrategy\\": 1,\\n \\"AppName\\": \\"test-app\\",\\n \\"Timezone\\": \\"HangKong\\",\\n \\"LastExecuteEndTime\\": \\"2025-06-29 15:56:36\\\\n\\",\\n \\"LastExecuteStatus\\": 4,\\n \\"CurrentExecuteStatus\\": 3,\\n \\"ChildJobId\\": \\"1246\\",\\n \\"Weight\\": 1,\\n \\"NodeType\\": 1,\\n \\"DependentStrategy\\": 1,\\n \\"Script\\": \\"#!/bin/bash\\\\necho \\\\\\"xxl-job: hello shell\\\\\\"\\\\necho \\\\\\"Good bye!\\\\\\"\\\\nexit 0\\",\\n \\"WorkflowId\\": 10,\\n \\"ExecutorBlockStrategy\\": \\"1\\",\\n \\"StartTimeType\\": 1\\n }\\n ],\\n \\"Total\\": 65,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]',
+ 'title' => '获取任务列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-06-04T09:10:28.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-24T09:10:14.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-17T09:51:37.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-11-29T02:39:12.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"AppName\\": \\"test-app\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"AlarmType\\": \\"schedulerx3_fail_alarm\\",\\n \\"AlarmChannel\\": \\"webhook\\",\\n \\"AlarmContacts\\": \\"zhangsan\\",\\n \\"AlarmStatus\\": \\"true\\",\\n \\"AlarmMessage\\": \\"报警类型：任务执行失败报警\\\\n运行环境：cn-xx\\\\n集群：xxljob-b6ec1acfb2c\\\\n应用名：testApp\\\\n任务ID及名称：8(failedjob)\\\\n实例ID：1308\\\\n触发时间：2024-11-19 13:57:10\\\\n失败次数：187\\\\n运行机器：http://192.***.***.5:9999/\\\\n失败原因：java.lang.reflect.InvocationTargetException\\",\\n \\"Time\\": \\"2024-10-31 16:43:51\\\\n\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 64\\n }\\n}","type":"json"}]',
- 'title' => '获取报警事件',
],
- 'ListScheduleTimes' => [
- 'summary' => '获取指定时间类型和表达式未来5次调度时间。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListK8sResource' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9875,80 +6392,47 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227423',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'AppName',
+ 'name' => 'K8sClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '同步命名空间的Kubernetes集群ID。Kubernetes集群已添加到ServiceMeshId指定的服务网格中。'."\n"
+ .'若查询k8s命名空间或k8s服务时，该字段为必填。', 'type' => 'string', 'required' => false, 'example' => 'cadb451ed7af04b0297f4be396a2196fc'],
],
[
- 'name' => 'TimeType',
+ 'name' => 'K8sNamespace',
'in' => 'query',
- 'schema' => [
- 'description' => '时间类型，目前仅支持cron。'."\n"
- .'- 1：cron。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- 'enum' => [
- '1',
- ],
- ],
+ 'schema' => ['description' => 'k8s集群的命名空间ID。'."\n"
+ .'若查询k8s服务时，该字段为必填。', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
- 'name' => 'TimeExpression',
+ 'name' => 'ResourceType',
'in' => 'query',
'schema' => [
- 'description' => '时间表达式。',
+ 'description' => '资源类型定义。',
'type' => 'string',
'required' => true,
- 'example' => '0 0/10 * * * ?',
- ],
- ],
- [
- 'name' => 'TimeZone',
- 'in' => 'query',
- 'schema' => [
- 'description' => '时区。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Asia/Beijing',
+ 'example' => 'cluster',
+ 'enum' => ['cluster', 'namespace', 'service'],
],
],
[
- 'name' => 'Calendar',
+ 'name' => 'VpcId',
'in' => 'query',
- 'schema' => [
- 'description' => '日历。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'workday',
- ],
+ 'schema' => ['description' => 'VPC ID。'."\n"
+ .'若选择ResourceType值为cluster时，该字段为必填。', 'type' => 'string', 'required' => false, 'example' => 'vpc-aa1a18236n90rqhuhhnhh'],
],
],
'responses' => [
@@ -9958,36 +6442,22 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '调度时间列表。',
+ 'description' => '-',
'type' => 'array',
'items' => [
- 'description' => '调度时间。',
- 'type' => 'string',
- 'example' => '2024-11-17 12:00:00',
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceName' => ['description' => 'k8s资源名称', 'type' => 'string', 'example' => 'q_ecs_enterprise_spot_c'],
+ 'ResourceId' => ['description' => 'k8s资源ID', 'type' => 'string', 'example' => 'xxljob-01632622cda2f'],
+ ],
],
],
],
@@ -9996,108 +6466,72 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取k8s资源',
+ 'summary' => '获取k8s资源',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"2024-11-17 12:00:00\\"\\n ]\\n}","type":"json"}]',
- 'title' => '获取指定时间类型和表达式未来5次调度时间',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"ResourceName\\": \\"q_ecs_enterprise_spot_c\\",\\n \\"ResourceId\\": \\"xxljob-01632622cda2f\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'ImportCalendar' => [
- 'summary' => '导入日历。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListLables' => [
+ 'summary' => '获取executor的label列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227446',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeCode' => '251680',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '日历名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'workday',
- ],
- ],
- [
- 'name' => 'Year',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2024',
- ],
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Months',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '月。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '[{"month":1,"days":[3,4,5,6,9,10,11,12,13,16,17,18,19,20,28,29,30,31]},{"month":2,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28]},{"month":3,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},{"month":4,"days":[3,4,6,7,10,11,12,13,14,17,18,19,20,21,23,24,25,26,27,28]},{"month":5,"days":[4,5,6,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]},{"month":6,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,25,26,27,28,29,30]},{"month":7,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},{"month":8,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},{"month":9,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28]},{"month":10,"days":[7,8,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30,31]},{"month":11,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30]},{"month":12,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]}]',
- ],
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15'],
],
],
'responses' => [
@@ -10107,36 +6541,25 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的<br />唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", 'type' => 'string', 'example' => '9079A828-9138-50F1-801E-F2BC3D222A06'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'type' => 'array',
'items' => [
- 'description' => '返回数据。',
- 'type' => 'string',
- 'example' => 'refresh calendar success',
+ 'type' => 'object',
+ 'properties' => [
+ 'Label' => ['description' => '标签。', 'type' => 'string', 'example' => 'gray'],
+ 'Online' => ['description' => '是否在线。', 'type' => 'boolean', 'example' => 'true'],
+ 'Size' => ['description' => '此标签下的机器数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'IsDesignated' => ['description' => '是否指定。', 'type' => 'boolean', 'example' => 'true'."\n"],
+ ],
+ 'description' => '',
],
+ 'description' => '',
],
],
],
@@ -10144,237 +6567,181 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"refresh calendar success\\"\\n ]\\n}","type":"json"}]',
- 'title' => '导入日历',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9079A828-9138-50F1-801E-F2BC3D222A06\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Label\\": \\"gray\\",\\n \\"Online\\": true,\\n \\"Size\\": 2,\\n \\"IsDesignated\\": true\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取executor的label列表',
+ 'changeSet' => [],
],
- 'ExportJobs' => [
- 'summary' => '批量导出任务信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListRegionZone' => [
+ 'summary' => '获取可用区列表。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227429',
- 'abilityTreeNodes' => [
- 'FEATUREmse7UN7CQ',
- ],
+ 'abilityTreeCode' => '231656',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
- 'in' => 'formData',
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'A short description of struct',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
+ 'title' => 'JSONResult',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'title' => '返回数据',
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => ['title' => 'zone id', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-beijing-j'],
+ 'LocalName' => ['title' => '本地名', 'description' => '本地名。', 'type' => 'string', 'example' => 'E'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'string', 'example' => 'IllegalRequest'],
+ 'Success' => ['title' => '是否成功(前端要使用)', 'description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识。', 'type' => 'string', 'example' => '438737AC-760A-57D9-B646-B7EF79426243'],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
+ ],
[
- 'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- 'name' => 'JobIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '74',
- ],
- 'required' => false,
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-j\\",\\n \\"LocalName\\": \\"E\\"\\n }\\n ],\\n \\"Code\\": 200,\\n \\"ErrorCode\\": \\"IllegalRequest\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"438737AC-760A-57D9-B646-B7EF79426243\\"\\n}","type":"json"}]',
+ 'title' => '获取可用区列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegionZone'],
],
+ ],
+ ],
+ 'ListRegions' => [
+ 'summary' => '获取所有region列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ExportJobType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '导出任务类型，默认值为1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- 'enum' => [
- '1',
- ],
- ],
+ 'AK' => [],
],
],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '227434',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回内容。',
- 'type' => 'string',
- 'format' => 'byte',
- 'example' => '{'."\n"
- .' "kind": "SchedulerXJobs",'."\n"
- .' "type": "JSON",'."\n"
- .' "version": "2.0",'."\n"
- .' "content": ['."\n"
- .' {'."\n"
- .' "appName": "test-app",'."\n"
- .' "groupId": "test-app",'."\n"
- .' "description": "测试应用",'."\n"
- .' "jobConfigInfo": ['."\n"
- .' {'."\n"
- .' "jobHandler": "jobDemoHandler",'."\n"
- .' "dataOffset": 0,'."\n"
- .' "executeMode": "standalone",'."\n"
- .' "monitorConfigInfo": {'."\n"
- .' "alarmType": "CustomContacts",'."\n"
- .' "failLimitTimes": 1,'."\n"
- .' "failEnable": true,'."\n"
- .' "failRate": 100,'."\n"
- .' "timeoutKillEnable": false,'."\n"
- .' "missWorkerEnable": false,'."\n"
- .' "sendChannel": "webhook,mail",'."\n"
- .' "timeoutEnable": true,'."\n"
- .' "timeout": 300,'."\n"
- .' "daysOfDeadline": 0,'."\n"
- .' "successNotice": false'."\n"
- .' },'."\n"
- .' "attemptInterval": 30,'."\n"
- .' "cleanMode": "{\\"cleanMode\\":\\"NUM_ONLY\\",\\"totalRemain\\":300}",'."\n"
- .' "description": "",'."\n"
- .' "routeStrategy": 1,'."\n"
- .' "userName": "1827811800526502",'."\n"
- .' "userId": "1827811800526502",'."\n"
- .' "content": "{\\"jobHandler\\":\\"helloworld\\"}",'."\n"
- .' "maxConcurrency": 1,'."\n"
- .' "maxAttempt": 0,'."\n"
- .' "name": "指定IP测试",'."\n"
- .' "xattrs": "",'."\n"
- .' "jobType": "xxljob",'."\n"
- .' "contentType": 1,'."\n"
- .' "parameters": "123",'."\n"
- .' "timeConfig": {'."\n"
- .' "dataOffset": 0,'."\n"
- .' "timeType": 1,'."\n"
- .' "paramMap": {'."\n"
- .' '."\n"
- .' },'."\n"
- .' "timeExpression": "0 * * * * ?"'."\n"
- .' },'."\n"
- .' "contactInfoList": ['."\n"
- .' {'."\n"
- .' "name": "xiaoming",'."\n"
- .' "contactType": 1'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "status": 1'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n"
- .' ]'."\n"
- .'}'."\n",
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Regions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionEndpoint' => ['title' => 'endpoint', 'description' => '地域服务的Endpoint。', 'type' => 'string', 'example' => 'schedulerx3.cn-hangzhou.aliyuncs.com'],
+ 'LocalName' => ['title' => '本地名', 'description' => '本地名。', 'type' => 'string', 'example' => 'China (Hangzhou)'],
+ 'RegionId' => ['title' => '地区ID', 'description' => '地区ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
+ ],
+ 'description' => '',
+ ],
+ 'description' => '',
+ ],
+ ],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"AFD5B166-4A7D-50DF-91BF-EFAFD41F7335\\",\\n \\"Success\\": true,\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"schedulerx3.cn-hangzhou.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取Region列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"\\"{\\\\n \\\\\\"kind\\\\\\": \\\\\\"SchedulerXJobs\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"JSON\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"2.0\\\\\\",\\\\n \\\\\\"content\\\\\\": [\\\\n {\\\\n \\\\\\"appName\\\\\\": \\\\\\"test-app\\\\\\",\\\\n \\\\\\"groupId\\\\\\": \\\\\\"test-app\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"测试应用\\\\\\",\\\\n \\\\\\"jobConfigInfo\\\\\\": [\\\\n {\\\\n \\\\\\"jobHandler\\\\\\": \\\\\\"jobDemoHandler\\\\\\",\\\\n \\\\\\"dataOffset\\\\\\": 0,\\\\n \\\\\\"executeMode\\\\\\": \\\\\\"standalone\\\\\\",\\\\n \\\\\\"monitorConfigInfo\\\\\\": {\\\\n \\\\\\"alarmType\\\\\\": \\\\\\"CustomContacts\\\\\\",\\\\n \\\\\\"failLimitTimes\\\\\\": 1,\\\\n \\\\\\"failEnable\\\\\\": true,\\\\n \\\\\\"failRate\\\\\\": 100,\\\\n \\\\\\"timeoutKillEnable\\\\\\": false,\\\\n \\\\\\"missWorkerEnable\\\\\\": false,\\\\n \\\\\\"sendChannel\\\\\\": \\\\\\"webhook,mail\\\\\\",\\\\n \\\\\\"timeoutEnable\\\\\\": true,\\\\n \\\\\\"timeout\\\\\\": 300,\\\\n \\\\\\"daysOfDeadline\\\\\\": 0,\\\\n \\\\\\"successNotice\\\\\\": false\\\\n },\\\\n \\\\\\"attemptInterval\\\\\\": 30,\\\\n \\\\\\"cleanMode\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"cleanMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NUM_ONLY\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"totalRemain\\\\\\\\\\\\\\":300}\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"routeStrategy\\\\\\": 1,\\\\n \\\\\\"userName\\\\\\": \\\\\\"1827811800526502\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"1827811800526502\\\\\\",\\\\n \\\\\\"content\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"jobHandler\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"helloworld\\\\\\\\\\\\\\"}\\\\\\",\\\\n \\\\\\"maxConcurrency\\\\\\": 1,\\\\n \\\\\\"maxAttempt\\\\\\": 0,\\\\n \\\\\\"name\\\\\\": \\\\\\"指定IP测试\\\\\\",\\\\n \\\\\\"xattrs\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"jobType\\\\\\": \\\\\\"xxljob\\\\\\",\\\\n \\\\\\"contentType\\\\\\": 1,\\\\n \\\\\\"parameters\\\\\\": \\\\\\"123\\\\\\",\\\\n \\\\\\"timeConfig\\\\\\": {\\\\n \\\\\\"dataOffset\\\\\\": 0,\\\\n \\\\\\"timeType\\\\\\": 1,\\\\n \\\\\\"paramMap\\\\\\": {\\\\n \\\\n },\\\\n \\\\\\"timeExpression\\\\\\": \\\\\\"0 * * * * ?\\\\\\"\\\\n },\\\\n \\\\\\"contactInfoList\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"xiaoming\\\\\\",\\\\n \\\\\\"contactType\\\\\\": 1\\\\n }\\\\n ],\\\\n \\\\\\"status\\\\\\": 1\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n}\\\\n\\"","type":"json"}]',
- 'title' => '批量导出任务',
],
- 'GetLog' => [
- 'summary' => '查询日志。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListScheduleEvent' => [
+ 'summary' => '查询调度事件。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10383,163 +6750,89 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227424',
- 'abilityTreeNodes' => [
- 'FEATUREmse8C5258',
- ],
+ 'abilityTreeCode' => '253606',
+ 'abilityTreeNodes' => ['FEATUREmse8C5258'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群 ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'JobName',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'test-job'],
],
[
'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'WorkflowName',
'in' => 'query',
- 'schema' => [
- 'description' => '开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1721636220',
- ],
+ 'schema' => ['title' => '工作流名称', 'description' => '工作流名称', 'type' => 'string', 'required' => false, 'example' => '流程001'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'WorkflowExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1721636220',
- ],
+ 'schema' => ['title' => '工作流执行ID', 'description' => '工作流执行ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1450568762586578000'],
],
[
- 'name' => 'Level',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '日志等级。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'INFO',
- 'enum' => [
- 'INFO',
- 'ERROR',
- 'WARN',
- 'DEBUG',
- ],
- ],
+ 'schema' => ['description' => '检索到事件的开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1581317873000'],
],
[
- 'name' => 'Keyword',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '搜索关键词。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'hello word',
- ],
+ 'schema' => ['description' => '检索到事件的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1728872796295'],
],
[
- 'name' => 'Offset',
+ 'name' => 'Event',
'in' => 'query',
- 'schema' => [
- 'description' => '偏移。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '事件ID。具体类型如下：'."\n"
+ .'- Scheduled。'."\n"
+ .'- Running。'."\n"
+ .'- Succeed。'."\n"
+ .'- Failed。'."\n"
+ .'- Failing_Auto_Retry。'."\n"
+ .'- Skip_Schedule。'."\n"
+ .'- Execute_Log。', 'type' => 'string', 'required' => false, 'example' => 'Failed'],
],
[
- 'name' => 'LineNum',
+ 'name' => 'EventType',
'in' => 'query',
- 'schema' => [
- 'description' => 'LineNum。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['title' => '事件类型', 'description' => '事件类型', 'type' => 'string', 'required' => false, 'example' => 'JOB | WORKFLOW', 'default' => 'JOB'],
],
[
- 'name' => 'Reverse',
+ 'name' => 'Keyword',
'in' => 'query',
- 'schema' => [
- 'description' => '是否降序：'."\n"
- ."\n"
- .' - **true**：按降序排序。'."\n"
- .' - **false**：按升序排序。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['description' => '查询关键字。', 'type' => 'string', 'required' => false, 'example' => 'hello word'],
],
[
- 'name' => 'LogId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '日志ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '344008',
- ],
+ 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20'],
],
[
- 'name' => 'WorkerAddr',
+ 'name' => 'PageNum',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'title' => '执行器地址',
- 'description' => '执行器地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => '192.168.1.100',
- ],
+ 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'ScheduleTime',
+ 'name' => 'Reverse',
'in' => 'query',
- 'schema' => [
- 'title' => '调度时间',
- 'description' => '调度时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2023-10-01 12:00:00',
- ],
+ 'schema' => ['description' => '是否降序。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
],
'responses' => [
@@ -10549,41 +6842,40 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'B880122A-B0E4-52E8-8F54-87DB7779EB74'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'type' => 'array',
- 'items' => [
- 'description' => '日志信息。',
- 'type' => 'string',
- 'example' => 'ip : 10.**.***.53:58098'."\n"
- .'executionId : 74_1310******761285120_0'."\n"
- .'level : INFO'."\n"
- .'log : hello word!;'."\n"
- .'time : 2024-10-31 16:43:51',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'description' => '结果集。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '单行数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EventType' => ['title' => '事件类型', 'description' => '事件类型', 'type' => 'string', 'example' => 'JOB'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ 'JobName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'test-job'],
+ 'JobExecutionId' => ['description' => '任务执行ID。', 'type' => 'string', 'example' => '1310630367761285120'],
+ 'WorkflowName' => ['title' => '工作流名称', 'description' => '工作流名称', 'type' => 'string', 'example' => '工作流0001'],
+ 'WorkflowExecutionId' => ['title' => '工作流执行记录ID', 'description' => '工作流执行记录ID', 'type' => 'string', 'example' => '1450568762586578000'],
+ 'Event' => ['description' => '事件ID。', 'type' => 'string', 'example' => 'Failed'],
+ 'WorkerAddr' => ['description' => '机器地址。', 'type' => 'string', 'example' => 'http://192.168.1.5:9999/'],
+ 'Content' => ['description' => '内容。', 'type' => 'string', 'example' => 'hello word'."\n"],
+ 'Time' => ['description' => '打印时间，格式为`yyyy-MM-dd HH:mm:ss`。', 'type' => 'string', 'example' => '2024-10-31 16:43:51'."\n"],
+ ],
+ ],
+ ],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
+ 'description' => '',
],
],
],
@@ -10591,231 +6883,91 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Data\\": [\\n \\"ip : 10.**.***.53:58098\\\\nexecutionId : 74_1310******761285120_0\\\\nlevel : INFO\\\\nlog : hello word!;\\\\ntime : 2024-10-31 16:43:51\\"\\n ]\\n}","type":"json"}]',
- 'title' => '查询日志',
- ],
- 'OperateMarkSuccessWorkflowExecution' => [
- 'summary' => '标记工作流实例为成功状态',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B880122A-B0E4-52E8-8F54-87DB7779EB74\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"EventType\\": \\"JOB\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"JobName\\": \\"test-job\\",\\n \\"JobExecutionId\\": \\"1310630367761285120\\",\\n \\"WorkflowName\\": \\"工作流0001\\",\\n \\"WorkflowExecutionId\\": \\"1450568762586578000\\",\\n \\"Event\\": \\"Failed\\",\\n \\"WorkerAddr\\": \\"http://192.168.1.5:9999/\\",\\n \\"Content\\": \\"hello word\\\\n\\",\\n \\"Time\\": \\"2024-10-31 16:43:51\\\\n\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 100\\n }\\n}","type":"json"}]',
+ 'title' => '查询调度事件',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:17.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-05-20T09:00:54.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduleEvent'],
+ ],
],
+ ],
+ 'ListScheduleTimes' => [
+ 'summary' => '获取指定时间类型和表达式未来5次调度时间。',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227436',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227423',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-d6a5243b6fa',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxl-job-executor-sample',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkflowExecutionId',
- 'in' => 'formData',
+ 'name' => 'TimeType',
+ 'in' => 'query',
'schema' => [
- 'description' => '工作流实例ID',
+ 'description' => '时间类型，目前仅支持cron。'."\n"
+ .'- 1：cron。',
'type' => 'integer',
- 'format' => 'int64',
+ 'format' => 'int32',
'required' => true,
- 'example' => '100',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '详细信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
- ],
- [
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
+ 'example' => '1',
+ 'enum' => ['1'],
],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DF6732E-15D8-5E1F-95E3-C10077F556B5\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter error: content is null.\\"\\n}","type":"json"}]',
- 'title' => '标记工作流实例为成功状态',
- ],
- 'OperateSkipJobExecution' => [
- 'summary' => '跳过任务实例',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '227437',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
- ],
- 'parameters' => [
- [
- 'name' => 'ClusterId',
+ 'name' => 'TimeExpression',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-d6a5243b6fa',
- ],
+ 'schema' => ['description' => '时间表达式。', 'type' => 'string', 'required' => true, 'example' => '0 0/10 * * * ?'],
],
[
- 'name' => 'AppName',
+ 'name' => 'TimeZone',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '时区。', 'type' => 'string', 'required' => false, 'example' => 'Asia/Beijing'],
],
[
- 'name' => 'JobExecutionId',
+ 'name' => 'Calendar',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '日历。', 'type' => 'string', 'required' => false, 'example' => 'workday'],
],
],
'responses' => [
@@ -10825,29 +6977,16 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '调度时间列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '调度时间。', 'type' => 'string', 'example' => '2024-11-17 12:00:00'],
],
],
],
@@ -10855,190 +6994,119 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"2024-11-17 12:00:00\\"\\n ]\\n}","type":"json"}]',
+ 'title' => '获取指定时间类型和表达式未来5次调度时间',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduleTimes'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '跳过任务实例',
],
- 'UpdateWorkflow' => [
- 'summary' => '更新工作流',
+ 'ListWorkflowExecutions' => [
+ 'summary' => '获取工作流实例列表',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227447',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-d6a5243b6fa',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'test-app'],
],
[
'name' => 'WorkflowId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkflow',
- ],
+ 'name' => 'WorkflowName',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流名称', 'type' => 'string', 'required' => false, 'example' => 'myWorkflow'],
],
[
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my first workflow',
- ],
+ 'name' => 'WorkflowExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
- 'name' => 'TimeType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '调度类型，目前支持以下几种类型：'."\n"
- .'- -1: none'."\n"
- .'- 1：cron'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流执行状态'."\n"
+ .'- 0: unknown'."\n"
+ .'- 1: waiting'."\n"
+ .'- 2: queued'."\n"
+ .'- 3: running'."\n"
+ .'- 4: success'."\n"
+ .'- 5: failed'."\n"
+ .'- 6: killed'."\n"
+ .'- 7: held'."\n"
+ .'- 8: mark_success'."\n"
+ .'- 9: skipped ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'],
],
[
- 'name' => 'TimeExpression',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
- .'- none：无需填写'."\n"
- .'- cron：填写标准的cron表达式，支持在线验证。'."\n"
- .'- api：无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0 0/10 * * * ?',
- ],
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2025-10-27 02:15:00'],
],
[
- 'name' => 'Timezone',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时区'."\n"
- .'> 默认使用schedulerx服务器所在时区',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GMT+8',
- ],
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2025-10-13 16:00:00'],
],
[
- 'name' => 'Calendar',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '自定义日历',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'workday',
- ],
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'MaxConcurrency',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '最大并发数'."\n"
- .'>同一个工作流同一时间允许运行的最大实例个数，1表示不允许重复执行。如果超过并发数，会跳过当前调度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
],
'responses' => [
@@ -11048,135 +7116,126 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'],
+ 'Message' => ['title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', 'type' => 'string', 'required' => true, 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'description' => '-',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkflowExecutionId' => ['description' => '工作流实例ID', 'type' => 'string', 'example' => '100'],
+ 'WorkflowId' => ['description' => '工作流ID', 'type' => 'string', 'example' => '10'],
+ 'WorkflowName' => ['description' => '工作流名称。', 'type' => 'string', 'example' => 'myWorkflow'],
+ 'ScheduleTime' => ['description' => '任务调度时间。', 'type' => 'string', 'example' => '2024-11-12 14:52:42'],
+ 'DataTime' => ['description' => '任务数据时间。', 'type' => 'string', 'example' => '2024-11-12 14:52:42'],
+ 'StartTime' => ['description' => '开始时间', 'type' => 'string', 'example' => '2025-11-04 01:09:27'],
+ 'EndTime' => ['description' => '任务结束时间。', 'type' => 'string', 'example' => '2024-11-12 14:52:42'],
+ 'Executor' => ['description' => '执行者ID。', 'type' => 'string', 'example' => '1827811800526000'],
+ 'Status' => ['description' => '任务执行状态。具体说明如下：'."\n"
+ .'- 0: UNKNOWN (未知)。'."\n"
+ .'- 1: WAITING (等待)。'."\n"
+ .'- 2: READY (准备就绪)。'."\n"
+ .'- 3: RUNNING (运行中)。'."\n"
+ .'- 4: SUCCESS (成功)。'."\n"
+ .'- 5: FAILED (失败)。'."\n"
+ .'- 6: PAUSED (已暂停)。'."\n"
+ .'- 7: SUBMITTED (已提交)。'."\n"
+ .'- 8: REJECTED (被拒绝)。'."\n"
+ .'- 9: ACCEPTED (已接受)。'."\n"
+ .'- 10: PARTIAL_FAILED (部分失败)。'."\n"
+ .'- 11: SKIPPED (已跳过)。'."\n"
+ .'- 12: REMOVED (已移除)。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test-app'],
+ ],
+ ],
+ ],
+ 'Total' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '65'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
],
+ 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新工作流',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"WorkflowExecutionId\\": \\"100\\",\\n \\"WorkflowId\\": \\"10\\",\\n \\"WorkflowName\\": \\"myWorkflow\\",\\n \\"ScheduleTime\\": \\"2024-11-12 14:52:42\\",\\n \\"DataTime\\": \\"2024-11-12 14:52:42\\",\\n \\"StartTime\\": \\"2025-11-04 01:09:27\\",\\n \\"EndTime\\": \\"2024-11-12 14:52:42\\",\\n \\"Executor\\": \\"1827811800526000\\",\\n \\"Status\\": 4,\\n \\"AppName\\": \\"test-app\\"\\n }\\n ],\\n \\"Total\\": 65,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\"\\n}","type":"json"}]',
+ 'title' => '获取工作流实例列表',
+ 'changeSet' => [],
],
- 'OperateEnableWorkflows' => [
- 'summary' => '启用工作流',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListWorkflowVersions' => [
+ 'summary' => '获取工作流版本列表',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227450',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
+ 'abilityTreeCode' => '227452',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxl-job-executor-sample',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxl-job-executor-sample'],
],
[
- 'name' => 'WorkflowIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '工作流ID列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'WorkflowId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
],
'responses' => [
@@ -11186,160 +7245,125 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '详细信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '工作流版本信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'DagVersion' => ['description' => '版本号', 'type' => 'string', 'example' => 'v1'],
+ 'Current' => ['description' => '是否是当前在用版本', 'type' => 'boolean', 'example' => 'true'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-10-29 15:56:36'],
+ ],
+ ],
],
+ 'NextToken' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
+ 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '启用工作流',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DagVersion\\": \\"v1\\",\\n \\"Current\\": true,\\n \\"CreateTime\\": \\"2024-10-29 15:56:36\\"\\n }\\n ],\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
+ 'title' => '获取工作流版本列表',
+ 'changeSet' => [],
],
- 'CreateCalendar' => [
- 'summary' => '创建自定义日历',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListWorkflows' => [
+ 'summary' => '获取工作流列表',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeCode' => '227452',
+ 'abilityTreeNodes' => ['FEATUREmsePN2NBR'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。您可以调用[ListClusters](~~28147~~)查看集群的ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'CalendarName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '',
- 'description' => '日历名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'workday',
- ],
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test-app'],
],
[
- 'name' => 'Year',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2026',
- ],
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流状态，默认为禁用状态。'."\n"
+ .'- 0: 禁用'."\n"
+ .'- 1: 启用', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Months',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '',
- 'description' => '每个月的日历，JSON数组格式',
- 'type' => 'string',
- 'required' => true,
- 'example' => '['."\n"
- .' {"month":1,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
- .' {"month":2,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
- .' {"month":3,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},'."\n"
- .' {"month":4,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},'."\n"
- .' {"month":5,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},'."\n"
- .' {"month":6,"days":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},'."\n"
- .' {"month":7,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},'."\n"
- .' {"month":8,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},'."\n"
- .' {"month":9,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},'."\n"
- .' {"month":10,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
- .' {"month":11,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
- .' {"month":12,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}'."\n"
- .']',
- ],
+ 'name' => 'WorkflowId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456789',
- ],
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流名称', 'type' => 'string', 'required' => false, 'example' => 'myWorkflow'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作流描述', 'type' => 'string', 'required' => false, 'example' => 'my first workflow'],
+ ],
+ [
+ 'name' => 'PageNum',
+ 'in' => 'query',
+ 'schema' => ['description' => '页数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'default' => '20'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
],
],
'responses' => [
@@ -11349,29 +7373,67 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'B880122A-B0E4-52E8-8F54-87DB7779EB74',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'CalendarName is already existed',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Records' => [
+ 'description' => '工作流列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '工作流基本信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkflowId' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'Name' => ['description' => '工作流名称', 'type' => 'string', 'example' => 'myWorkflow'],
+ 'Description' => ['description' => '工作流描述', 'type' => 'string', 'example' => 'my first workflow'],
+ 'Status' => ['description' => '工作流状态：'."\n"
+ .'- 0: 禁用'."\n"
+ .'- 1: 启用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'MaxConcurrency' => ['description' => '最大并发数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'TimeType' => ['description' => '调度类型，目前支持以下几种类型：'."\n"
+ .'- -1: none'."\n"
+ .'- 1：cron'."\n"
+ .'- 100:：api', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TimeExpression' => ['description' => '时间表达式', 'type' => 'string', 'example' => '0 0 12 * * ?'],
+ 'Timezone' => ['description' => '时区。', 'type' => 'string', 'example' => 'HangKong'],
+ 'Calendar' => ['description' => '日历。', 'type' => 'string', 'example' => 'work-day'],
+ 'Creator' => ['description' => '创建人。', 'type' => 'string', 'example' => '1963096506470832'],
+ 'Updater' => ['description' => '更新者。', 'type' => 'string', 'example' => '1963096506470832'],
+ 'Xattrs' => ['description' => '扩展属性'."\n"
+ .'> 暂不支持', 'type' => 'string', 'example' => '暂无'],
+ 'AppName' => ['description' => '应用名。', 'type' => 'string', 'example' => 'test-app'],
+ 'LastExecuteEndTime' => ['description' => '上一次执行结束时间。', 'type' => 'string', 'example' => '2025-06-29 15:56:36'."\n"],
+ 'LastExecuteStatus' => ['description' => '上一次的执行结果。'."\n"
+ .'- 4: 成功'."\n"
+ .'- 5: 失败', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'CurrentExecuteStatus' => [
+ 'description' => '当前执行状态：'."\n"
+ .'- 0：未开始。'."\n"
+ .'- 1：运行中。'."\n"
+ .'- 2：队列中。'."\n"
+ .'- 3：等待中。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ 'enum' => ['0', '1', '2', '3'],
+ ],
+ 'AppType' => ['description' => '应用类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ ],
+ 'Total' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '64'],
+ 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'MaxResults' => ['description' => '本次读取的最大数据量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NextToken' => ['description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ=='],
+ ],
],
],
],
@@ -11379,51 +7441,31 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B880122A-B0E4-52E8-8F54-87DB7779EB74\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"CalendarName is already existed\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '创建日历',
- 'description' => '创建自定义日历',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"WorkflowId\\": 10,\\n \\"Name\\": \\"myWorkflow\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"Status\\": 1,\\n \\"MaxConcurrency\\": 100,\\n \\"TimeType\\": 1,\\n \\"TimeExpression\\": \\"0 0 12 * * ?\\",\\n \\"Timezone\\": \\"HangKong\\",\\n \\"Calendar\\": \\"work-day\\",\\n \\"Creator\\": \\"1963096506470832\\",\\n \\"Updater\\": \\"1963096506470832\\",\\n \\"Xattrs\\": \\"暂无\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"LastExecuteEndTime\\": \\"2025-06-29 15:56:36\\\\n\\",\\n \\"LastExecuteStatus\\": 4,\\n \\"CurrentExecuteStatus\\": 3,\\n \\"AppType\\": 1\\n }\\n ],\\n \\"Total\\": 64,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取工作流列表',
+ 'changeSet' => [],
],
- 'ImportWorkflows' => [
- 'summary' => '导入工作流',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateBackfillWorkflow' => [
+ 'summary' => '回补工作流历史数据',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11435,55 +7477,35 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227422',
- 'abilityTreeNodes' => [
- 'FEATUREmse7UN7CQ',
- ],
+ 'abilityTreeCode' => '227436',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => 'A short description of struct',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-a1804a3226d',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Overwrite',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '如果已存在，是否覆盖。默认值为 true。'."\n"
- .'- true：覆盖。'."\n"
- .'- false：不覆盖。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'Content',
+ 'name' => 'WorkflowId',
'in' => 'formData',
- 'schema' => [
- 'description' => '导入内容。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[{"kind":"SchedulerXWorkflows","type":"JSON","version":"2.0","workflowInfo":{"name":"myWorkflow","description":"","appName":"xuerentest","appType":1,"maxConcurrency":1,"currentExecuteStatus":0,"timeConfig":{"timeType":1,"timeExpression":"0 0 12 * * ?","dataOffset":0}},"nodes":[{"name":"Java1","startTime":-1,"coordinate":{"x":-222.0,"y":40.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld\\"}","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell1","startTime":-1,"coordinate":{"x":102.0,"y":-51.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"Java2","startTime":-1,"coordinate":{"x":390.0,"y":55.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld2\\"}","xattrs":"{\\"executorBlockStrategy\\":1,\\"localParams\\":[]}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell2","startTime":-1,"coordinate":{"x":89.0,"y":161.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world2\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]}],"edges":[{"from":"Java1","to":"shell1"},{"from":"Java1","to":"shell2"},{"from":"Schedulerx-Root","to":"Java1"},{"from":"shell1","to":"Java2"},{"from":"shell2","to":"Java2"}]}]',
- ],
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'],
],
[
- 'name' => 'AutoCreateApp',
+ 'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'description' => '自动创建应用。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '回补数据的开始日期', 'type' => 'string', 'required' => true, 'example' => '2025-11-01'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'formData',
+ 'schema' => ['description' => '回补数据的结束日期', 'type' => 'string', 'required' => true, 'example' => '2025-11-03'],
],
],
'responses' => [
@@ -11493,81 +7515,43 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '导入工作流',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter error: content is null.\\"\\n}","type":"json"}]',
+ 'title' => '回补工作流历史数据',
+ 'changeSet' => [],
],
- 'GetWorkflow' => [
- 'summary' => '获取工作流的基本信息',
+ 'OperateConnectDatasource' => [
+ 'summary' => '连接数据源',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11576,47 +7560,32 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227452',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227426',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxl-job-executor-sample',
- ],
+ 'name' => 'Type',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源的类型。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'WorkflowId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '20',
- ],
+ 'name' => 'ConnectionParams',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源连接参数', 'type' => 'string', 'required' => true, 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}'],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据库用户的密码。', 'type' => 'string', 'required' => true, 'example' => '***'],
],
],
'responses' => [
@@ -11626,166 +7595,45 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'WorkflowId' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Name' => [
- 'description' => '工作流名称',
- 'type' => 'string',
- 'example' => 'myWorkflow',
- ],
- 'Description' => [
- 'description' => '工作流描述',
- 'type' => 'string',
- 'example' => 'my first workflow',
- ],
- 'Status' => [
- 'description' => '工作流状态'."\n"
- .'- 0：禁用'."\n"
- .'- 1：启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'MaxConcurrency' => [
- 'description' => '最大并发数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TimeType' => [
- 'description' => '调度类型：'."\n"
- .'- -1: none'."\n"
- .'- 1：cron'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TimeExpression' => [
- 'description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
- .'- **none**：无需填写'."\n"
- .'- **cron**：填写标准的cron表达式，支持在线验证。'."\n"
- .'- **api**：无需填写',
- 'type' => 'string',
- 'example' => '0 0 12 * * ?',
- ],
- 'Timezone' => [
- 'description' => '时区'."\n"
- .'> 默认使用当前region服务器所在时区',
- 'type' => 'string',
- 'example' => 'GMT+8',
- ],
- 'Calendar' => [
- 'description' => '自定义日历',
- 'type' => 'string',
- 'example' => 'workday',
- ],
- 'Creator' => [
- 'description' => '创建人。',
- 'type' => 'string',
- 'example' => '18582193685027xx',
- ],
- 'Updater' => [
- 'description' => '更新人。',
- 'type' => 'string',
- 'example' => '18582193685027xx',
- ],
- 'Xattrs' => [
- 'description' => '扩展属性。'."\n"
- .'> 暂不支持',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '测试连接数据源',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkflowId\\": 10,\\n \\"Name\\": \\"myWorkflow\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"Status\\": 2,\\n \\"MaxConcurrency\\": 100,\\n \\"TimeType\\": 1,\\n \\"TimeExpression\\": \\"0 0 12 * * ?\\",\\n \\"Timezone\\": \\"GMT+8\\",\\n \\"Calendar\\": \\"workday\\",\\n \\"Creator\\": \\"18582193685027xx\\",\\n \\"Updater\\": \\"18582193685027xx\\",\\n \\"Xattrs\\": \\"null\\",\\n \\"AppName\\": \\"test-app\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取工作流的基本信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'OperateUnskipJobExecution' => [
- 'summary' => '将跳过状态的任务实例恢复',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateDesignateExecutors' => [
+ 'summary' => '指定执行器。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11797,40 +7645,53 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227437',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '227425',
+ 'abilityTreeNodes' => ['FEATUREmseWGXOHM'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'query',
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74'],
+ ],
+ [
+ 'name' => 'Transferable',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否故障转移。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'DesignateType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
+ 'description' => '指定机器的类型。取值如下：'."\n"
+ .'- **1**：指定worker。'."\n"
+ .'- **2**：指定label。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'test-app',
+ 'example' => '1',
+ 'enum' => ['1', '2'],
],
],
[
- 'name' => 'JobExecutionId',
- 'in' => 'query',
+ 'name' => 'AddressList',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
+ 'description' => '地址列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '机器地址。', 'type' => 'string', 'required' => false, 'example' => 'http://192.168.***.5:9999/'],
+ 'required' => true,
],
],
],
@@ -11841,243 +7702,161 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error'."\n",
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- ."\n"
- .'- true：调用成功。 '."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335'],
+ 'Success' => ['description' => '是否调用成功。具体取值如下：'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '取消跳过任务实例',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"AFD5B166-4A7D-50DF-91BF-EFAFD41F7335\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '指定执行器',
+ 'changeSet' => [],
],
- 'ExportWorkflows' => [
- 'summary' => '导出工作流为JSON格式，包含工作流基本信息、工作流内所有节点信息、工作流的DAG依赖关系',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateDisableJobs' => [
+ 'summary' => '批量禁用任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227429',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227445',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'title' => 'A short description of struct',
- 'description' => 'A short description of struct',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'WorkflowId',
+ 'name' => 'AppName',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '工作流ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
],
[
- 'name' => 'AppName',
+ 'name' => 'JobIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
+ 'type' => 'array',
+ 'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74'],
+ 'required' => true,
+ 'docRequired' => true,
+ 'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '请求体。',
- 'type' => 'string',
- 'format' => 'byte',
- 'example' => '[{"kind":"SchedulerXWorkflows","type":"JSON","version":"2.0","workflowInfo":{"name":"myWorkflow","description":"","appName":"xuerentest","appType":1,"maxConcurrency":1,"currentExecuteStatus":0,"timeConfig":{"timeType":1,"timeExpression":"0 0 12 * * ?","dataOffset":0}},"nodes":[{"name":"Java1","startTime":-1,"coordinate":{"x":-222.0,"y":40.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld\\"}","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell1","startTime":-1,"coordinate":{"x":102.0,"y":-51.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"Java2","startTime":-1,"coordinate":{"x":390.0,"y":55.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"xxljob","executeMode":"standalone","contentType":1,"content":"{\\"jobHandler\\":\\"helloworld2\\"}","xattrs":"{\\"executorBlockStrategy\\":1,\\"localParams\\":[]}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]},{"name":"shell2","startTime":-1,"coordinate":{"x":89.0,"y":161.0,"width":220.0,"height":76.0},"appName":"xuerentest","description":"","jobType":"script_shell","executeMode":"standalone","contentType":2,"content":"echo \\"hello world2\\"","xattrs":"{\\"executorBlockStrategy\\":1}","dependentStrategy":1,"routeStrategy":1,"parameters":"","maxConcurrency":1,"maxAttempt":0,"attemptInterval":30,"priority":5,"weight":1,"timeConfig":{"timeType":1,"calendar":"","dataOffset":0},"monitorConfigInfo":{"timeoutEnable":true,"failEnable":true,"failLimitTimes":1,"failRate":100,"missWorkerEnable":true,"timeout":300,"timeoutKillEnable":false,"daysOfDeadline":0,"sendChannel":"","alarmType":"CustomContacts","successNotice":false,"endEarlyEnable":false,"endEarly":30},"contactInfoList":[]}],"edges":[{"from":"Java1","to":"shell1"},{"from":"Java1","to":"shell2"},{"from":"Schedulerx-Root","to":"Java1"},{"from":"shell1","to":"Java2"},{"from":"shell2","to":"Java2"}]}]',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '批量禁用任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateDisableJobs'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"\\"[{\\\\\\"kind\\\\\\":\\\\\\"SchedulerXWorkflows\\\\\\",\\\\\\"type\\\\\\":\\\\\\"JSON\\\\\\",\\\\\\"version\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"workflowInfo\\\\\\":{\\\\\\"name\\\\\\":\\\\\\"myWorkflow\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"appType\\\\\\":1,\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"currentExecuteStatus\\\\\\":0,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"timeExpression\\\\\\":\\\\\\"0 0 12 * * ?\\\\\\",\\\\\\"dataOffset\\\\\\":0}},\\\\\\"nodes\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"Java1\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":-222.0,\\\\\\"y\\\\\\":40.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"xxljob\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":1,\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"jobHandler\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"helloworld\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]},{\\\\\\"name\\\\\\":\\\\\\"shell1\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":102.0,\\\\\\"y\\\\\\":-51.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"script_shell\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":2,\\\\\\"content\\\\\\":\\\\\\"echo \\\\\\\\\\\\\\"hello world\\\\\\\\\\\\\\"\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]},{\\\\\\"name\\\\\\":\\\\\\"Java2\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":390.0,\\\\\\"y\\\\\\":55.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"xxljob\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":1,\\\\\\"content\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"jobHandler\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"helloworld2\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"localParams\\\\\\\\\\\\\\":[]}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]},{\\\\\\"name\\\\\\":\\\\\\"shell2\\\\\\",\\\\\\"startTime\\\\\\":-1,\\\\\\"coordinate\\\\\\":{\\\\\\"x\\\\\\":89.0,\\\\\\"y\\\\\\":161.0,\\\\\\"width\\\\\\":220.0,\\\\\\"height\\\\\\":76.0},\\\\\\"appName\\\\\\":\\\\\\"xuerentest\\\\\\",\\\\\\"description\\\\\\":\\\\\\"\\\\\\",\\\\\\"jobType\\\\\\":\\\\\\"script_shell\\\\\\",\\\\\\"executeMode\\\\\\":\\\\\\"standalone\\\\\\",\\\\\\"contentType\\\\\\":2,\\\\\\"content\\\\\\":\\\\\\"echo \\\\\\\\\\\\\\"hello world2\\\\\\\\\\\\\\"\\\\\\",\\\\\\"xattrs\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"executorBlockStrategy\\\\\\\\\\\\\\":1}\\\\\\",\\\\\\"dependentStrategy\\\\\\":1,\\\\\\"routeStrategy\\\\\\":1,\\\\\\"parameters\\\\\\":\\\\\\"\\\\\\",\\\\\\"maxConcurrency\\\\\\":1,\\\\\\"maxAttempt\\\\\\":0,\\\\\\"attemptInterval\\\\\\":30,\\\\\\"priority\\\\\\":5,\\\\\\"weight\\\\\\":1,\\\\\\"timeConfig\\\\\\":{\\\\\\"timeType\\\\\\":1,\\\\\\"calendar\\\\\\":\\\\\\"\\\\\\",\\\\\\"dataOffset\\\\\\":0},\\\\\\"monitorConfigInfo\\\\\\":{\\\\\\"timeoutEnable\\\\\\":true,\\\\\\"failEnable\\\\\\":true,\\\\\\"failLimitTimes\\\\\\":1,\\\\\\"failRate\\\\\\":100,\\\\\\"missWorkerEnable\\\\\\":true,\\\\\\"timeout\\\\\\":300,\\\\\\"timeoutKillEnable\\\\\\":false,\\\\\\"daysOfDeadline\\\\\\":0,\\\\\\"sendChannel\\\\\\":\\\\\\"\\\\\\",\\\\\\"alarmType\\\\\\":\\\\\\"CustomContacts\\\\\\",\\\\\\"successNotice\\\\\\":false,\\\\\\"endEarlyEnable\\\\\\":false,\\\\\\"endEarly\\\\\\":30},\\\\\\"contactInfoList\\\\\\":[]}],\\\\\\"edges\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"Java1\\\\\\",\\\\\\"to\\\\\\":\\\\\\"shell1\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"Java1\\\\\\",\\\\\\"to\\\\\\":\\\\\\"shell2\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"Schedulerx-Root\\\\\\",\\\\\\"to\\\\\\":\\\\\\"Java1\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"shell1\\\\\\",\\\\\\"to\\\\\\":\\\\\\"Java2\\\\\\"},{\\\\\\"from\\\\\\":\\\\\\"shell2\\\\\\",\\\\\\"to\\\\\\":\\\\\\"Java2\\\\\\"}]}]\\"","type":"json"}]',
- 'title' => '导出工作流',
],
- 'GetWorkflowDAG' => [
- 'summary' => '获取工作流DAG信息',
+ 'OperateDisableWorkflows' => [
+ 'summary' => '禁用工作流',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '260227',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227449',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-a1804a3226d',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkflowId',
- 'in' => 'query',
+ 'name' => 'WorkflowIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
+ 'description' => '工作流ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ 'required' => true,
+ 'docRequired' => true,
],
],
],
@@ -12088,372 +7867,130 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '查询结果。',
- 'type' => 'object',
- 'properties' => [
- 'Nodes' => [
- 'description' => '返回的数据类型。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回的数据类型。',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Name' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => 'job1',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'oak-payment-async-job',
- ],
- 'Status' => [
- 'description' => '任务状态'."\n"
- .'- 0：禁用'."\n"
- .'- 1：启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'JobType' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'example' => 'script_shell',
- ],
- 'Coordinate' => [
- 'description' => '节点的坐标信息',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'description' => '节点的X轴坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '50',
- ],
- 'Y' => [
- 'description' => '节点的Y轴坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '50',
- ],
- 'Width' => [
- 'description' => '节点宽度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
- ],
- 'Height' => [
- 'description' => '节点高度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '20',
- ],
- ],
- ],
- 'DependentStrategy' => [
- 'description' => '依赖策略',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'all_success',
- ],
- ],
- ],
- ],
- 'Edges' => [
- 'description' => '工作流边列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '节点之间的边',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'description' => '边起点的任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Target' => [
- 'description' => '边终点的任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '禁用工作流',
+ 'description' => '手动导入执行器',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"Id\\": 5,\\n \\"Name\\": \\"job1\\",\\n \\"AppName\\": \\"oak-payment-async-job\\",\\n \\"Status\\": 1,\\n \\"JobType\\": \\"script_shell\\",\\n \\"Coordinate\\": {\\n \\"X\\": 50,\\n \\"Y\\": 50,\\n \\"Width\\": 100,\\n \\"Height\\": 20\\n },\\n \\"DependentStrategy\\": 0\\n }\\n ],\\n \\"Edges\\": [\\n {\\n \\"Source\\": 3,\\n \\"Target\\": 4\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取工作流DAG信息',
],
- 'ListWorkflowVersions' => [
- 'summary' => '获取工作流版本列表',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateEnableJobs' => [
+ 'summary' => '批量启用任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227452',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227450',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxl-job-executor-sample',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkflowId',
- 'in' => 'query',
+ 'name' => 'JobIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '工作流ID。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'type' => 'array',
+ 'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74'],
'required' => true,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
+ 'docRequired' => true,
+ 'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'array',
- 'items' => [
- 'description' => '工作流版本信息',
- 'type' => 'object',
- 'properties' => [
- 'DagVersion' => [
- 'description' => '版本号',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Current' => [
- 'description' => '是否是当前在用版本',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-10-29 15:56:36',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '4CC4132F-B798-5D6E-9F06-D44B33E417E9'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"4CC4132F-B798-5D6E-9F06-D44B33E417E9\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '批量启用任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateEnableJobs'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"DagVersion\\": \\"v1\\",\\n \\"Current\\": true,\\n \\"CreateTime\\": \\"2024-10-29 15:56:36\\"\\n }\\n ],\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
- 'title' => '获取工作流版本列表',
],
- 'OperateHoldJobExecution' => [
- 'summary' => '挂起还未执行的任务实例',
+ 'OperateEnableWorkflows' => [
+ 'summary' => '启用工作流',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -12465,40 +8002,31 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227437',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '227450',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'xxl-job-executor-sample'],
],
[
- 'name' => 'JobExecutionId',
- 'in' => 'query',
+ 'name' => 'WorkflowIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
+ 'description' => '工作流ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ 'required' => true,
+ 'docRequired' => true,
],
],
],
@@ -12509,160 +8037,105 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'not support query script history, please upgrade engine version to 2.2.2+',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '挂起还未执行的任务实例',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '启用工作流',
+ 'changeSet' => [],
],
- 'DeleteCalendar' => [
- 'summary' => '删除指定日历',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateExecuteJob' => [
+ 'summary' => '运行一次任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227426',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeCode' => '227439',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'CalendarName',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '',
- 'description' => '日历名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'workday',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
],
[
- 'name' => 'Year',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2024',
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '74'],
+ ],
+ [
+ 'name' => 'InstanceParameters',
+ 'in' => 'formData',
+ 'schema' => ['description' => '实例参数。', 'type' => 'string', 'required' => false, 'example' => 'name=zhangsan'],
+ ],
+ [
+ 'name' => 'Worker',
+ 'in' => 'formData',
+ 'schema' => ['title' => '指定机器的workerAddr', 'description' => '指定机器的workerAddr。', 'type' => 'string', 'required' => false, 'example' => 'http://192.168.***.5:9999/'],
+ ],
+ [
+ 'name' => 'Label',
+ 'in' => 'formData',
+ 'schema' => ['title' => '指定机器的标签', 'description' => '指定机器的标签。', 'type' => 'string', 'required' => false, 'example' => 'gray'],
],
],
'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' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题', 'type' => 'string', 'example' => '6305893D-517D-5131-A767-644EDA81CEC3'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'JobExecutionId' => ['description' => '任务执行ID。', 'type' => 'string', 'example' => '1310630367761285120'],
+ ],
+ 'description' => '',
],
],
],
@@ -12670,51 +8143,35 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"6305893D-517D-5131-A767-644EDA81CEC3\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobExecutionId\\": \\"1310630367761285120\\"\\n }\\n}","type":"json"}]',
+ 'title' => '运行一次任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateExecuteJob'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF99C381-C8F6-5A8D-8C24-57F46B706D2D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除日历',
],
- 'UpdateWorkflowDAG' => [
- 'summary' => '更新工作流的DAG信息，包含节点坐标和边信息',
+ 'OperateExecuteWorkflow' => [
+ 'summary' => '运行一次工作流',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -12723,210 +8180,27 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227447',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227439',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-a1804a3226d',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- 'maxLength' => 64,
- 'minLength' => 1,
- 'pattern' => '^[0-9a-zA-Z_-]+$',
- ],
+ 'schema' => ['description' => '应用名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
],
[
'name' => 'WorkflowId',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Dag',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '工作流DAG信息',
- 'type' => 'object',
- 'properties' => [
- 'Nodes' => [
- 'description' => '工作流节点列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '节点信息',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- 'Coordinate' => [
- 'description' => '节点坐标',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'description' => 'X坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '50',
- ],
- 'Y' => [
- 'description' => 'Y坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '50',
- ],
- 'Width' => [
- 'description' => '节点宽度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '100',
- ],
- 'Height' => [
- 'description' => '节点高度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- 'required' => false,
- ],
- 'Content' => [
- 'description' => '逻辑节点表达式',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "logicType": "status_branch",'."\n"
- .' "conditionResult": {'."\n"
- .' "successList": ['."\n"
- .' {'."\n"
- .' "jobName": "status-job4",'."\n"
- .' "jobId": "269"'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "failedList": ['."\n"
- .' {'."\n"
- .' "jobName": "status-job5",'."\n"
- .' "jobId": "270"'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' },'."\n"
- .' "dependence": {'."\n"
- .' "relation": "AND",'."\n"
- .' "dependList": ['."\n"
- .' {'."\n"
- .' "relation": "AND",'."\n"
- .' "dependItemList": ['."\n"
- .' {'."\n"
- .' "jobName": "status-job1",'."\n"
- .' "jobId": 265,'."\n"
- .' "status": ['."\n"
- .' 4'."\n"
- .' ]'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "jobName": "status-job2",'."\n"
- .' "jobId": 266,'."\n"
- .' "status": ['."\n"
- .' 5'."\n"
- .' ]'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "relation": "AND",'."\n"
- .' "dependItemList": ['."\n"
- .' {'."\n"
- .' "jobName": "status-job3",'."\n"
- .' "jobId": 267,'."\n"
- .' "status": ['."\n"
- .' 4'."\n"
- .' ]'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' }'."\n"
- .'}'."\n",
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'Edges' => [
- 'description' => '工作流边列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '边信息，source->target表示边的方向',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'description' => '边起点的任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3',
- ],
- 'Target' => [
- 'description' => '边终点的任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '4',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'DagVersion',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务流版本号，可调用[ListDAGVersions](~~465989~~)接口获取该参数的值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1137005',
- ],
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20'],
],
],
'responses' => [
@@ -12936,28 +8210,18 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC',
- ],
- 'Success' => [
- 'description' => '请求返回状态。'."\n"
- .'- true：成功。'."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkflowExecutionId' => ['description' => '工作流实例ID', 'type' => 'string', 'example' => '100'],
+ ],
],
],
],
@@ -12965,52 +8229,32 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新工作流的DAG信息',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkflowExecutionId\\": \\"100\\"\\n }\\n}","type":"json"}]',
+ 'title' => '运行一次工作流',
+ 'description' => '手动导入执行器',
+ 'changeSet' => [],
],
- 'OperateUnholdJobExecution' => [
- 'summary' => '将挂起状态的任务实例恢复执行',
+ 'OperateHoldJobExecution' => [
+ 'summary' => '挂起还未执行的任务实例',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13019,44 +8263,27 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227437',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-d6a5243b6fa',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '任务执行ID', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
],
'responses' => [
@@ -13066,82 +8293,43 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '取消挂起任务实例',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '挂起还未执行的任务实例',
+ 'changeSet' => [],
],
'OperateHoldWorkflowExecution' => [
'summary' => '挂起工作流实例，会将工作流中还未执行的节点挂起',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13154,42 +8342,24 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227436',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-d6a5243b6fa',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxl-job-executor-sample',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'xxl-job-executor-sample'],
],
[
'name' => 'WorkflowExecutionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流实例ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
],
'responses' => [
@@ -13199,82 +8369,43 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'not support query script history, please upgrade engine version to 2.2.2+',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\"\\n}","type":"json"}]',
'title' => '挂起工作流实例',
+ 'changeSet' => [],
],
- 'OperateBackfillWorkflow' => [
- 'summary' => '回补工作流历史数据',
+ 'OperateMarkSuccessJobExecution' => [
+ 'summary' => '标记任务实例为成功状态',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13283,66 +8414,27 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227436',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227437',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'WorkflowId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'StartDate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '回补数据的开始日期',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025-11-01',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'EndDate',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '回补数据的结束日期',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025-11-03',
- ],
+ 'name' => 'JobExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行ID', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
],
'responses' => [
@@ -13352,81 +8444,43 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter error: content is null.\\"\\n}","type":"json"}]',
- 'title' => '回补工作流历史数据',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '标记任务实例为成功状态',
+ 'changeSet' => [],
],
- 'DeleteWorkflows' => [
- 'summary' => '批量删除工作流',
+ 'OperateMarkSuccessWorkflowExecution' => [
+ 'summary' => '标记工作流实例为成功状态',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13435,65 +8489,28 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227449',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
+ 'abilityTreeCode' => '227436',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-a1804a3226d',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'xxl-job-executor-sample'],
],
[
- 'name' => 'WorkflowIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '工作流ID列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'DeleteJobs',
+ 'name' => 'WorkflowExecutionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否删除工作流下的所有任务',
- 'description' => '是否删除工作流下的所有任务',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => '工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
],
'responses' => [
@@ -13503,79 +8520,42 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '批量删除工作流',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1DF6732E-15D8-5E1F-95E3-C10077F556B5\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter error: content is null.\\"\\n}","type":"json"}]',
+ 'title' => '标记工作流实例为成功状态',
+ 'changeSet' => [],
],
- 'UpdateCalendar' => [
- 'summary' => '更新日历',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateRerunJob' => [
+ 'summary' => '重刷任务历史数据。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13584,79 +8564,42 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeCode' => '227442',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'CalendarName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '',
- 'description' => '日历名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'workday',
- ],
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'Year',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2024',
- ],
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74'],
],
[
- 'name' => 'Months',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '',
- 'description' => '月。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '[{"month":1,"days":[3,4,5,6,9,10,11,12,13,16,17,18,19,20,28,29,30,31]},{"month":2,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28]},{"month":3,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},{"month":4,"days":[3,4,6,7,10,11,12,13,14,17,18,19,20,21,23,24,25,26,27,28]},{"month":5,"days":[4,5,6,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]},{"month":6,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,25,26,27,28,29,30]},{"month":7,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},{"month":8,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},{"month":9,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28]},{"month":10,"days":[7,8,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30,31]},{"month":11,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30]},{"month":12,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]}]',
- ],
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1698458024000'],
],
[
- 'name' => 'Incremental',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '是否是增量更新（默认：false）。'."\n"
- .'- false 更新指定月份数据的同时会删除其他月份的配置'."\n"
- .'- true 仅更新指定月份的数据，保留其他月份的现有配置',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1698458024000'],
],
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
+ 'name' => 'DataTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '数据时间。', 'type' => 'string', 'required' => true, 'example' => '14:11:10'],
],
],
'responses' => [
@@ -13666,82 +8609,47 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'BCDF4006-C8A1-5F83-9368-588347D3EE84'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCDF4006-C8A1-5F83-9368-588347D3EE84\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]',
+ 'title' => '重刷任务历史数据',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateRerunJob'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新日历',
],
- 'OperateRetryWorkflowExecution' => [
- 'summary' => '重跑工作流实例',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateRetryJobExecution' => [
+ 'summary' => '重跑失败的任务实例。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13754,54 +8662,41 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227436',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkflowExecutionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流实例ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1450568762586578000',
- ],
+ 'name' => 'JobExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120'],
],
[
- 'name' => 'OnlyFailed',
- 'in' => 'formData',
+ 'name' => 'TaskList',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '是否只重跑失败的节点',
- 'type' => 'boolean',
+ 'description' => '子任务执行 ID列表（分片广播任务）。'."\n"
+ .'>在需要重跑某个分片广播任务的子任务时，请将此字段设置为相应子任务的执行 ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '子任务执行ID。', 'type' => 'string', 'required' => false, 'example' => '1311649782220996611'."\n"],
'required' => false,
- 'example' => 'true',
- 'default' => 'true',
],
],
+ [
+ 'name' => 'TriggerChild',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否触发下游', 'description' => '是否触发下游', 'type' => 'boolean', 'required' => false, 'default' => 'true'],
+ ],
],
'responses' => [
200 => [
@@ -13810,80 +8705,48 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '438737AC-760A-57D9-B646-B7EF79426243'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- true：调用成功。 '."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'success'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"438737AC-760A-57D9-B646-B7EF79426243\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
+ 'title' => '重跑任务实例',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:17.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-28T05:40:55.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-27T12:09:49.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]',
- 'title' => '重跑工作流实例',
],
- 'UpdateWorkflowDAGVersion' => [
- 'summary' => '切换工作流DAG版本',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateRetryWorkflowExecution' => [
+ 'summary' => '重跑工作流实例',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13892,60 +8755,33 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227447',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeCode' => '227436',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- 'maxLength' => 64,
- 'minLength' => 1,
- 'pattern' => '^[0-9a-zA-Z_-]+$',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkflowId',
+ 'name' => 'WorkflowExecutionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1450568762586578000'],
],
[
- 'name' => 'DagVersion',
+ 'name' => 'OnlyFailed',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流DAG版本号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v1',
- ],
+ 'schema' => ['description' => '是否只重跑失败的节点', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
],
'responses' => [
@@ -13955,131 +8791,72 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263',
- ],
- 'Success' => [
- 'description' => '是否调用成功。具体取值如下：'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '切换工作流DAG版本',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]',
+ 'title' => '重跑工作流实例',
+ 'changeSet' => [],
],
- 'GetCalendar' => [
- 'summary' => '获取日历',
+ 'OperateSkipJobExecution' => [
+ 'summary' => '跳过任务实例',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '251680',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227437',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'title' => '',
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
[
- 'name' => 'CalendarName',
+ 'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '日历名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'workday',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'Year',
+ 'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2024',
- ],
+ 'schema' => ['description' => '任务执行ID', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
],
'responses' => [
@@ -14089,164 +8866,82 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'CalendarName' => [
- 'description' => '日历名称',
- 'type' => 'string',
- 'example' => 'workday',
- ],
- 'Year' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2030',
- ],
- 'Months' => [
- 'description' => '月。',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {"month":1,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
- .' {"month":2,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
- .' {"month":3,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},'."\n"
- .' {"month":4,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},'."\n"
- .' {"month":5,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},'."\n"
- .' {"month":6,"days":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},'."\n"
- .' {"month":7,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},'."\n"
- .' {"month":8,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},'."\n"
- .' {"month":9,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},'."\n"
- .' {"month":10,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
- .' {"month":11,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
- .' {"month":12,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}'."\n"
- .']',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CalendarName\\": \\"workday\\",\\n \\"Year\\": 2030,\\n \\"Months\\": \\"[\\\\n {\\\\\\"month\\\\\\":1,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":2,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":3,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},\\\\n {\\\\\\"month\\\\\\":4,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},\\\\n {\\\\\\"month\\\\\\":5,\\\\\\"days\\\\\\":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},\\\\n {\\\\\\"month\\\\\\":6,\\\\\\"days\\\\\\":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},\\\\n {\\\\\\"month\\\\\\":7,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":8,\\\\\\"days\\\\\\":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},\\\\n {\\\\\\"month\\\\\\":9,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},\\\\n {\\\\\\"month\\\\\\":10,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":11,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":12,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}\\\\n]\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取日历',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '跳过任务实例',
+ 'changeSet' => [],
],
- 'GetWorkflowExecutionDAG' => [
- 'summary' => '获取工作流实例的DAG信息',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'OperateStopJobExecution' => [
+ 'summary' => '停止正在运行的任务实例。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '260227',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227437',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkflowExecutionId',
+ 'name' => 'JobExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行ID', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120'],
+ ],
+ [
+ 'name' => 'TaskList',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '工作流执行ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '100',
+ 'title' => '子任务ID',
+ 'description' => '子任务ID',
+ 'type' => 'array',
+ 'items' => ['title' => '子任务id', 'description' => '子任务id', 'type' => 'string', 'required' => false, 'example' => '[1,2,3]'],
+ 'required' => false,
],
],
],
@@ -14257,317 +8952,80 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter format error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '查询结果。',
- 'type' => 'object',
- 'properties' => [
- 'Nodes' => [
- 'description' => '节点信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '节点信息。',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'ID。',
- 'type' => 'string',
- 'example' => '7491777526619542799',
- ],
- 'Name' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'job1',
- ],
- 'AppName' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'example' => 'cua-xxl-job-executor',
- ],
- 'Status' => [
- 'description' => '任务执行状态。具体说明如下：'."\n"
- .'- 0: unknown'."\n"
- .'- 1: waiting '."\n"
- .'- 2: queued'."\n"
- .'- 3: running'."\n"
- .'- 4: success'."\n"
- .'- 5: failed'."\n"
- .'- 6: killed'."\n"
- .'- 7: held'."\n"
- .'- 8: mark_success'."\n"
- .'- 9: skipped',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'JobType' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'example' => 'script_shell',
- ],
- 'Coordinate' => [
- 'description' => '节点的坐标信息',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'description' => '节点的X轴坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '50',
- ],
- 'Y' => [
- 'description' => '节点的Y轴坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '50',
- ],
- 'Width' => [
- 'description' => '节点宽度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
- ],
- 'Height' => [
- 'description' => '节点高度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '20',
- ],
- ],
- ],
- 'JobId' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9',
- ],
- ],
- ],
- ],
- 'Edges' => [
- 'description' => '工作流的边列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '通过source->target描述边信息，source=0表示根节点',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'description' => '边起点的任务执行ID',
- 'type' => 'string',
- 'example' => '1000',
- ],
- 'Target' => [
- 'description' => '边终点的任务执行ID',
- 'type' => 'string',
- 'example' => '1001',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'E82D8B33-204D-58E1-8F56-909F6B48F3D1'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'Success' => ['description' => '是否调用成功。**true**：调用成功。**false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E82D8B33-204D-58E1-8F56-909F6B48F3D1\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '停止正在运行的任务实例',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:17.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-28T05:40:55.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-27T12:09:49.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateStopJobExecution'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"Id\\": \\"7491777526619542799\\",\\n \\"Name\\": \\"job1\\",\\n \\"AppName\\": \\"cua-xxl-job-executor\\",\\n \\"Status\\": 4,\\n \\"JobType\\": \\"script_shell\\",\\n \\"Coordinate\\": {\\n \\"X\\": 50,\\n \\"Y\\": 50,\\n \\"Width\\": 100,\\n \\"Height\\": 20\\n },\\n \\"JobId\\": 9\\n }\\n ],\\n \\"Edges\\": [\\n {\\n \\"Source\\": \\"1000\\",\\n \\"Target\\": \\"1001\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取工作流实例的DAG信息',
],
- 'ListWorkflows' => [
- 'summary' => '获取工作流列表',
+ 'OperateStopWorkflowExecution' => [
+ 'summary' => '停止正在运行的工作流实例',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227452',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
+ 'abilityTreeCode' => '227436',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
[
'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流状态，默认为禁用状态。'."\n"
- .'- 0: 禁用'."\n"
- .'- 1: 启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'WorkflowId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkflow',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my first workflow',
- ],
- ],
- [
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- 'default' => '20',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
+ 'name' => 'WorkflowExecutionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
],
'responses' => [
@@ -14577,236 +9035,46 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'object',
- 'properties' => [
- 'Records' => [
- 'description' => '工作流列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '工作流基本信息',
- 'type' => 'object',
- 'properties' => [
- 'WorkflowId' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Name' => [
- 'description' => '工作流名称',
- 'type' => 'string',
- 'example' => 'myWorkflow',
- ],
- 'Description' => [
- 'description' => '工作流描述',
- 'type' => 'string',
- 'example' => 'my first workflow',
- ],
- 'Status' => [
- 'description' => '工作流状态：'."\n"
- .'- 0: 禁用'."\n"
- .'- 1: 启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MaxConcurrency' => [
- 'description' => '最大并发数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TimeType' => [
- 'description' => '调度类型，目前支持以下几种类型：'."\n"
- .'- -1: none'."\n"
- .'- 1：cron'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TimeExpression' => [
- 'description' => '时间表达式',
- 'type' => 'string',
- 'example' => '0 0 12 * * ?',
- ],
- 'Timezone' => [
- 'description' => '时区。',
- 'type' => 'string',
- 'example' => 'HangKong',
- ],
- 'Calendar' => [
- 'description' => '日历。',
- 'type' => 'string',
- 'example' => 'work-day',
- ],
- 'Creator' => [
- 'description' => '创建人。',
- 'type' => 'string',
- 'example' => '1963096506470832',
- ],
- 'Updater' => [
- 'description' => '更新者。',
- 'type' => 'string',
- 'example' => '1963096506470832',
- ],
- 'Xattrs' => [
- 'description' => '扩展属性'."\n"
- .'> 暂不支持',
- 'type' => 'string',
- 'example' => '暂无',
- ],
- 'AppName' => [
- 'description' => '应用名。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- 'LastExecuteEndTime' => [
- 'description' => '上一次执行结束时间。',
- 'type' => 'string',
- 'example' => '2025-06-29 15:56:36'."\n",
- ],
- 'LastExecuteStatus' => [
- 'description' => '上一次的执行结果。'."\n"
- .'- 4: 成功'."\n"
- .'- 5: 失败',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'CurrentExecuteStatus' => [
- 'description' => '当前执行状态：'."\n"
- .'- 0：未开始。'."\n"
- .'- 1：运行中。'."\n"
- .'- 2：队列中。'."\n"
- .'- 3：等待中。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- ],
- ],
- 'AppType' => [
- 'description' => '应用类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'Total' => [
- 'description' => '总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '64',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]',
+ 'title' => '停止正在运行的工作流实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"39938688-0BAB-5AD8-BF02-F4910FAC7589\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"WorkflowId\\": 10,\\n \\"Name\\": \\"myWorkflow\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"Status\\": 1,\\n \\"MaxConcurrency\\": 100,\\n \\"TimeType\\": 1,\\n \\"TimeExpression\\": \\"0 0 12 * * ?\\",\\n \\"Timezone\\": \\"HangKong\\",\\n \\"Calendar\\": \\"work-day\\",\\n \\"Creator\\": \\"1963096506470832\\",\\n \\"Updater\\": \\"1963096506470832\\",\\n \\"Xattrs\\": \\"暂无\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"LastExecuteEndTime\\": \\"2025-06-29 15:56:36\\\\n\\",\\n \\"LastExecuteStatus\\": 4,\\n \\"CurrentExecuteStatus\\": 3,\\n \\"AppType\\": 1\\n }\\n ],\\n \\"Total\\": 64,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取工作流列表',
],
- 'OperateMarkSuccessJobExecution' => [
- 'summary' => '标记任务实例为成功状态',
+ 'OperateUnholdJobExecution' => [
+ 'summary' => '将挂起状态的任务实例恢复执行',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -14815,44 +9083,27 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227437',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
'name' => 'JobExecutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务执行ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1310630367761285120',
- ],
+ 'schema' => ['description' => '任务执行ID', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
],
'responses' => [
@@ -14862,81 +9113,46 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n"],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '取消挂起任务实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '标记任务实例为成功状态',
],
- 'CreateWorkflow' => [
- 'summary' => '创建工作流',
+ 'OperateUnholdWorkflowExecution' => [
+ 'summary' => '将挂起状态的工作流实例恢复执行',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -14945,143 +9161,103 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227447',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
+ 'abilityTreeCode' => '227436',
+ 'abilityTreeNodes' => ['FEATUREmse4EL0AA'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'xxl-job-executor-sample',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'my-workflow',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'Description',
+ 'name' => 'WorkflowExecutionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my first workflow for data analyse',
- ],
+ 'schema' => ['description' => '工作流实例ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'],
],
- [
- 'name' => 'TimeType',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '时间类型：'."\n"
- .'- -1: none<br/>'."\n"
- .'- 1：cron<br/>'."\n"
- .'- 100:：api',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '-1',
- 'enum' => [
- '-1',
- '1',
- '100',
+ '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' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
],
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
+ ],
[
- 'name' => 'TimeExpression',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
- .'- **none**：无需填写'."\n"
- .'- **cron**：填写标准的cron表达式，支持在线验证。'."\n"
- .'- **api**：无需填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0 0 4 ? * Mon/1'."\n",
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- 'name' => 'Calendar',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'cron类型可以选择填写自定义日历。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'workday',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter error: content is null.\\"\\n}","type":"json"}]',
+ 'title' => '取消挂起工作流实例',
+ 'changeSet' => [],
+ ],
+ 'OperateUnskipJobExecution' => [
+ 'summary' => '将跳过状态的任务实例恢复',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Timezone',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '时区',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GMT+8',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '227437',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
+ ],
+ 'parameters' => [
[
- 'name' => 'MaxConcurrency',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流并发数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'ClusterId',
+ 'in' => 'query',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '工作流状态，默认为禁用状态。'."\n"
- .'- 0: 禁用'."\n"
- .'- 1: 启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456789',
- ],
+ 'name' => 'JobExecutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120'],
],
],
'responses' => [
@@ -15091,232 +9267,133 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'WorkflowId' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'."\n"],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ ."\n"
+ .'- true：调用成功。 '."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkflowId\\": 10\\n }\\n}","type":"json"}]',
- 'title' => '创建工作流',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '取消跳过任务实例',
+ 'changeSet' => [],
],
- 'OperateDisableWorkflows' => [
- 'summary' => '禁用工作流',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SyncJobs' => [
+ 'summary' => '同步任务。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227449',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
+ 'abilityTreeCode' => '227445',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ClusterId',
+ 'name' => 'OriginalClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '原始集群ID，任务原本所在的集群。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-00ed7f0d742b1'],
],
[
- 'name' => 'AppName',
+ 'name' => 'OriginalAppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '原始应用名称，任务原本所在的应用。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-source'],
],
[
- 'name' => 'WorkflowIds',
+ 'name' => 'JobIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '工作流ID列表',
+ 'description' => '任务ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'items' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '56'],
'required' => true,
'docRequired' => true,
],
],
+ [
+ 'name' => 'TargetClusterId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '目标集群ID，任务需要同步到的集群。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-008bfb1541111'],
+ ],
+ [
+ 'name' => 'TargetAppName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '目标应用名称，任务需要同步到的应用。', 'type' => 'string', 'required' => true, 'example' => 'test-target'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '详细信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Not found: appName not found.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"5EF879D0-3B43-5AD1-9BF7-52418F9C5E73\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '禁用工作流',
- 'description' => '手动导入执行器',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Not found: appName not found.\\",\\n \\"RequestId\\": \\"6BCE89B3-E882-511D-9A75-D452A56EC4B1\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '同步任务',
+ 'changeSet' => [],
],
- 'OperateUnholdWorkflowExecution' => [
- 'summary' => '将挂起状态的工作流实例恢复执行',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateApp' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -15325,46 +9402,57 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227436',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227448',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$'],
],
[
- 'name' => 'WorkflowExecutionId',
+ 'name' => 'AccessToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流实例ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '100',
- ],
+ 'schema' => ['description' => '登录态访问令牌。', 'type' => 'string', 'required' => false, 'example' => 'f312159702f4469585586ed5a6904163v3', 'maxLength' => 32, 'minLength' => 6, 'pattern' => '^[\\w.-]+$'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['description' => '标题内容。', 'type' => 'string', 'required' => true, 'example' => '测试应用', 'maxLength' => 64, 'minLength' => 1],
+ ],
+ [
+ 'name' => 'MaxConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务执行队列大小。'."\n"
+ .'> 一个应用最多同时运行的任务实例个数，超过并发数的任务实例不会丢弃，会放在队列中等待执行', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'EnableLog',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否开启日志。'."\n"
+ ."\n"
+ .'- true：开启。'."\n"
+ ."\n"
+ .'- false：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'LabelRouteStrategy',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'description' => ''],
+ ],
+ [
+ 'name' => 'WorkerId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'responses' => [
@@ -15374,81 +9462,50 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '详细信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '39AA91C1-7BB7-5934-B15B-FD8E706D76C4'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter error: content is null.\\"\\n}","type":"json"}]',
- 'title' => '取消挂起工作流实例',
- ],
- 'OperateExecuteWorkflow' => [
- 'summary' => '运行一次工作流',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新应用',
+ 'summary' => '更新应用分组。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApp'],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39AA91C1-7BB7-5934-B15B-FD8E706D76C4\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'UpdateCalendar' => [
+ 'summary' => '更新日历',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -15457,47 +9514,43 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227439',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'AppName',
+ 'name' => 'CalendarName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['title' => '', 'description' => '日历名称', 'type' => 'string', 'required' => true, 'example' => 'workday'],
],
[
- 'name' => 'WorkflowId',
+ 'name' => 'Year',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '年。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024'],
+ ],
+ [
+ 'name' => 'Months',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => '月。', 'type' => 'string', 'required' => true, 'example' => '[{"month":1,"days":[3,4,5,6,9,10,11,12,13,16,17,18,19,20,28,29,30,31]},{"month":2,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28]},{"month":3,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},{"month":4,"days":[3,4,6,7,10,11,12,13,14,17,18,19,20,21,23,24,25,26,27,28]},{"month":5,"days":[4,5,6,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]},{"month":6,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,25,26,27,28,29,30]},{"month":7,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},{"month":8,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},{"month":9,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28]},{"month":10,"days":[7,8,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30,31]},{"month":11,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30]},{"month":12,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]}]'],
+ ],
+ [
+ 'name' => 'Incremental',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否是增量更新（默认：false）。'."\n"
+ .'- false 更新指定月份数据的同时会删除其他月份的配置'."\n"
+ .'- true 仅更新指定月份的数据，保留其他月份的现有配置', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
],
],
'responses' => [
@@ -15507,93 +9560,45 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'WorkflowExecutionId' => [
- 'description' => '工作流实例ID',
- 'type' => 'string',
- 'example' => '100',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '更新日历',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkflowExecutionId\\": \\"100\\"\\n }\\n}","type":"json"}]',
- 'title' => '运行一次工作流',
- 'description' => '手动导入执行器',
],
- 'OperateStopWorkflowExecution' => [
- 'summary' => '停止正在运行的工作流实例',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateCluster' => [
+ 'summary' => '更新集群。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -15602,46 +9607,27 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '227436',
- 'abilityTreeNodes' => [
- 'FEATUREmse4EL0AA',
- ],
- 'tenantRelevance' => 'tenant',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '227451',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-a1804a3226d',
- ],
+ 'schema' => ['title' => 'A short description of struct', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-c20f7ec9a78'],
],
[
- 'name' => 'AppName',
+ 'name' => 'ClusterName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '集群名称。', 'type' => 'string', 'required' => false, 'example' => 'xx-test-1107', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
- 'name' => 'WorkflowExecutionId',
+ 'name' => 'IpWhitelist',
'in' => 'formData',
- 'schema' => [
- 'description' => '工作流实例ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '100',
- ],
+ 'schema' => ['title' => '实例级别ip白名单', 'type' => 'string', 'example' => '192.168.1.0/24'],
],
],
'responses' => [
@@ -15651,166 +9637,87 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter check error',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'EEF9AF15-AEEF-5E59-BF7B-BCBB119DC53F'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新集群',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCluster'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]',
- 'title' => '停止正在运行的工作流实例',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"EEF9AF15-AEEF-5E59-BF7B-BCBB119DC53F\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'ListCalendars' => [
- 'summary' => '获取日历列表',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateContact' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '251680',
- 'abilityTreeNodes' => [
- 'FEATUREmseCPRKIU',
- ],
- 'autoTest' => true,
+ 'abilityTreeNodes' => ['FEATUREmseFDWH5S'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '',
- 'description' => '集群 ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'name' => 'ContactName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要更新的联系人名称', 'type' => 'string', 'required' => true, 'example' => 'Tom'],
],
[
- 'name' => 'CalendarName',
- 'in' => 'query',
+ 'name' => 'Type',
+ 'in' => 'formData',
'schema' => [
- 'description' => '日历名称',
+ 'description' => '联系人的类型。',
'type' => 'string',
'required' => false,
- 'example' => 'workday',
- ],
- ],
- [
- 'name' => 'Year',
- 'in' => 'query',
- 'schema' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2024',
- ],
- ],
- [
- 'name' => 'FetchCalendarDetail',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否拉取日历明细（默认：false）'."\n"
- .'- false：不返回每月的详细天列表，只返回基础信息。'."\n"
- .'- true：返回每月日历详细天列表。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
+ 'example' => 'IM',
+ 'enum' => ['IM', 'WEBHOOK', 'SMS'],
],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '20',
- ],
+ 'name' => 'Config',
+ 'in' => 'formData',
+ 'schema' => ['description' => '渠道参数配置 JSON 字符串（可选，传入则更新）', 'type' => 'string', 'required' => false, 'example' => '{"channels":[{"channelType":"dingtalk","clientId":"xxx","clientSecret":"xxx","targetType":"group","targetId":"xxx","robotCode":"xxx"}]}'],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
+ 'name' => 'Enabled',
+ 'in' => 'formData',
+ 'schema' => ['description' => '启用或者禁用该联系人通知渠道', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -15820,201 +9727,90 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'Records' => [
- 'description' => '数据列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据列表。',
- 'type' => 'object',
- 'properties' => [
- 'CalendarName' => [
- 'description' => '日历名称',
- 'type' => 'string',
- 'example' => 'workday',
- ],
- 'Year' => [
- 'description' => '年。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2025',
- ],
- 'Months' => [
- 'description' => '每个月的日历，JSON数组格式',
- 'type' => 'string',
- 'example' => '['."\n"
- .' {"month":1,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
- .' {"month":2,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
- .' {"month":3,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},'."\n"
- .' {"month":4,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},'."\n"
- .' {"month":5,"days":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},'."\n"
- .' {"month":6,"days":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},'."\n"
- .' {"month":7,"days":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},'."\n"
- .' {"month":8,"days":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},'."\n"
- .' {"month":9,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},'."\n"
- .' {"month":10,"days":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},'."\n"
- .' {"month":11,"days":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},'."\n"
- .' {"month":12,"days":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}'."\n"
- .']',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '详细信息。', 'type' => 'string', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新联系人',
+ 'summary' => '更新通知联系人',
+ 'description' => '更新通知联系人',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"CalendarName\\": \\"workday\\",\\n \\"Year\\": 2025,\\n \\"Months\\": \\"[\\\\n {\\\\\\"month\\\\\\":1,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":2,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":3,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28,31]},\\\\n {\\\\\\"month\\\\\\":4,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30]},\\\\n {\\\\\\"month\\\\\\":5,\\\\\\"days\\\\\\":[1,2,5,6,7,8,9,12,13,14,15,16,19,20,21,22,23,26,27,28,29,30]},\\\\n {\\\\\\"month\\\\\\":6,\\\\\\"days\\\\\\":[2,3,4,5,6,9,10,11,12,13,16,17,18,19,20,23,24,25,26,27,30]},\\\\n {\\\\\\"month\\\\\\":7,\\\\\\"days\\\\\\":[1,2,3,4,7,8,9,10,11,14,15,16,17,18,21,22,23,24,25,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":8,\\\\\\"days\\\\\\":[1,4,5,6,7,8,11,12,13,14,15,18,19,20,21,22,25,26,27,28,29]},\\\\n {\\\\\\"month\\\\\\":9,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30]},\\\\n {\\\\\\"month\\\\\\":10,\\\\\\"days\\\\\\":[1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30,31]},\\\\n {\\\\\\"month\\\\\\":11,\\\\\\"days\\\\\\":[3,4,5,6,7,10,11,12,13,14,17,18,19,20,21,24,25,26,27,28]},\\\\n {\\\\\\"month\\\\\\":12,\\\\\\"days\\\\\\":[1,2,3,4,5,8,9,10,11,12,15,16,17,18,19,22,23,24,25,26,29,30,31]}\\\\n]\\"\\n }\\n ],\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\",\\n \\"Total\\": 10,\\n \\"MaxResults\\": 10\\n }\\n}","type":"json"}]',
- 'title' => '获取日历列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\",\\n \\"RequestId\\": \\"F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetWorkflowDAGPreview' => [
- 'summary' => '获取工作流历史版本的DAG',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateDatasource' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '260227',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeNodes' => ['FEATUREmse8UT78G'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'name' => 'DatasourceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源ID，可通过接口ListDatasources获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'WorkflowId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源名称', 'type' => 'string', 'required' => false, 'example' => '账单拉取-支付宝团购'],
],
[
- 'name' => 'DagVersion',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流DAG的版本号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'v1',
- ],
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '', 'description' => '数据源描述', 'type' => 'string', 'required' => false, 'example' => 'None'],
+ ],
+ [
+ 'name' => 'ConnectionParams',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据源连接参数', 'type' => 'string', 'required' => false, 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}'],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据库密码', 'type' => 'string', 'required' => false, 'example' => '2F9e9@a69c!e18b569c8'],
],
],
'responses' => [
@@ -16024,336 +9820,124 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'B8733786-C045-59F1-8D79-99A52863F62D',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'Nodes' => [
- 'description' => '工作流节点列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Name' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'job1',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'settle-job',
- ],
- 'Status' => [
- 'description' => '任务状态：'."\n"
- .'- 0: 禁用'."\n"
- .'- 1: 启用',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'JobType' => [
- 'description' => '任务类型。',
- 'type' => 'string',
- 'example' => 'script_shell',
- ],
- 'Coordinate' => [
- 'description' => '节点的坐标信息',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'description' => '节点的X轴坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '50',
- ],
- 'Y' => [
- 'description' => '节点的Y轴坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '50',
- ],
- 'Width' => [
- 'description' => '节点宽度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
- ],
- 'Height' => [
- 'description' => '节点高度，可以不填',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '20',
- ],
- ],
- ],
- 'DependentStrategy' => [
- 'description' => '依赖策略',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'all_success',
- ],
- ],
- ],
- ],
- 'Edges' => [
- 'description' => '工作流的边列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '工作流的边信息',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'description' => '边起始节点的任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
- 'Target' => [
- 'description' => '边终点的任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter format error'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新数据源',
+ 'summary' => '更新数据源',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B8733786-C045-59F1-8D79-99A52863F62D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"Id\\": 3,\\n \\"Name\\": \\"job1\\",\\n \\"AppName\\": \\"settle-job\\",\\n \\"Status\\": 1,\\n \\"JobType\\": \\"script_shell\\",\\n \\"Coordinate\\": {\\n \\"X\\": 50,\\n \\"Y\\": 50,\\n \\"Width\\": 100,\\n \\"Height\\": 20\\n },\\n \\"DependentStrategy\\": 0\\n }\\n ],\\n \\"Edges\\": [\\n {\\n \\"Source\\": 3,\\n \\"Target\\": 4\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取工作流历史版本的DAG',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'ListWorkflowExecutions' => [
- 'summary' => '获取工作流实例列表',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateExecutorGroup' => [
+ 'summary' => '更新执行器组',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse09FNQO'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
[
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-app',
- ],
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'ID。', 'type' => 'string', 'required' => true, 'example' => '110176', 'deprecated' => true],
],
[
- 'name' => 'WorkflowId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string'],
],
[
- 'name' => 'WorkflowName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'myWorkflow',
- ],
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => '执行器组描述。', 'type' => 'string', 'required' => false, 'example' => 'group1'],
],
[
- 'name' => 'WorkflowExecutionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流实例ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 'name' => 'WorkerType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '执行器类型', 'type' => 'string', 'required' => false, 'example' => 'openclaw'],
],
[
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工作流执行状态'."\n"
- .'- 0: unknown'."\n"
- .'- 1: waiting'."\n"
- .'- 2: queued'."\n"
- .'- 3: running'."\n"
- .'- 4: success'."\n"
- .'- 5: failed'."\n"
- .'- 6: killed'."\n"
- .'- 7: held'."\n"
- .'- 8: mark_success'."\n"
- .'- 9: skipped ',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '4',
- ],
+ 'name' => 'Protocol',
+ 'in' => 'formData',
+ 'schema' => ['description' => '协议。', 'type' => 'string', 'required' => false, 'example' => 'openai'],
],
[
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '开始时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-10-27 02:15:00',
- ],
+ 'name' => 'Network',
+ 'in' => 'formData',
+ 'schema' => ['description' => '网络配置', 'type' => 'string', 'required' => false, 'example' => 'public'],
],
[
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '结束时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-10-13 16:00:00',
- ],
+ 'name' => 'AuthType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '认证类型', 'type' => 'string', 'required' => false, 'example' => 'APP'],
],
[
- 'name' => 'PageNum',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'ApiKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户端密钥。', 'type' => 'string', 'required' => false, 'example' => 'K4KWGINZVY9JwcZT0/vpSg=='],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'name' => 'Workers',
+ 'in' => 'formData',
+ 'schema' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'required' => false, 'example' => '[{"address":"http://47.111.188.191:18789"}]'],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'name' => 'AutoScale',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'boolean'],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
+ 'name' => 'CmsWorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string'],
+ ],
+ [
+ 'name' => 'XAttrs',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string'],
],
],
'responses' => [
@@ -16363,193 +9947,70 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9',
- ],
- 'Message' => [
- 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263'],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'."\n"],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '-',
'type' => 'object',
'properties' => [
- 'Records' => [
- 'description' => '-',
- 'type' => 'array',
- 'items' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'WorkflowExecutionId' => [
- 'description' => '工作流实例ID',
- 'type' => 'string',
- 'example' => '100',
- ],
- 'WorkflowId' => [
- 'description' => '工作流ID',
- 'type' => 'string',
- 'example' => '10',
- ],
- 'WorkflowName' => [
- 'description' => '工作流名称。',
- 'type' => 'string',
- 'example' => 'myWorkflow',
- ],
- 'ScheduleTime' => [
- 'description' => '任务调度时间。',
- 'type' => 'string',
- 'example' => '2024-11-12 14:52:42',
- ],
- 'DataTime' => [
- 'description' => '任务数据时间。',
- 'type' => 'string',
- 'example' => '2024-11-12 14:52:42',
- ],
- 'StartTime' => [
- 'description' => '开始时间',
- 'type' => 'string',
- 'example' => '2025-11-04 01:09:27',
- ],
- 'EndTime' => [
- 'description' => '任务结束时间。',
- 'type' => 'string',
- 'example' => '2024-11-12 14:52:42',
- ],
- 'Executor' => [
- 'description' => '执行者ID。',
- 'type' => 'string',
- 'example' => '1827811800526000',
- ],
- 'Status' => [
- 'description' => '任务执行状态。具体说明如下：'."\n"
- .'- 0: UNKNOWN (未知)。'."\n"
- .'- 1: WAITING (等待)。'."\n"
- .'- 2: READY (准备就绪)。'."\n"
- .'- 3: RUNNING (运行中)。'."\n"
- .'- 4: SUCCESS (成功)。'."\n"
- .'- 5: FAILED (失败)。'."\n"
- .'- 6: PAUSED (已暂停)。'."\n"
- .'- 7: SUBMITTED (已提交)。'."\n"
- .'- 8: REJECTED (被拒绝)。'."\n"
- .'- 9: ACCEPTED (已接受)。'."\n"
- .'- 10: PARTIAL_FAILED (部分失败)。'."\n"
- .'- 11: SKIPPED (已跳过)。'."\n"
- .'- 12: REMOVED (已移除)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'AppName' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'example' => 'test-app',
- ],
- ],
- ],
- ],
- 'Total' => [
- 'description' => '总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '65',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '每页的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'WorkerId' => ['description' => '部署任务Worker ID。此处ID可通过[ListWorkerResource](~~2712224~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'example' => 'ins-95mfvqrtg6fkijt1uko000'],
+ 'Name' => ['description' => '工作流名称', 'type' => 'string', 'example' => 'myWorkflow'],
+ 'Description' => ['description' => '工作流描述', 'type' => 'string', 'example' => 'my first workflow'],
+ 'WorkerType' => ['description' => '执行器类型', 'type' => 'string', 'example' => 'k8s_service'],
+ 'Workers' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
+ 'AuthType' => ['description' => '认证类型，包含如下两种类型：'."\n"
+ .'- **Anonymous**：表示不需要认证。'."\n"
+ .'- **Application**：表示需要认证。'."\n"
+ .'> 默认类型为**Anonymous**。', 'type' => 'string', 'example' => 'EDIT'],
+ 'Protocol' => ['description' => '域名支持的协议类型。HTTP：仅支持HTTP协议。HTTPS：仅支持HTTPS协议。HTTP,HTTPS：支持HTTP及HTTPS协议。', 'type' => 'string', 'example' => 'TCP'],
+ 'Network' => ['description' => '网络数据。', 'type' => 'string', 'example' => '{\\"OfficeSiteId\\":\\"cn-hangzhou+dir-8801187585\\",\\"VSwitchIds\\":[null]}'],
+ 'FailedService' => ['description' => '导入失败的k8s服务', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
],
],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新执行器组',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"WorkflowExecutionId\\": \\"100\\",\\n \\"WorkflowId\\": \\"10\\",\\n \\"WorkflowName\\": \\"myWorkflow\\",\\n \\"ScheduleTime\\": \\"2024-11-12 14:52:42\\",\\n \\"DataTime\\": \\"2024-11-12 14:52:42\\",\\n \\"StartTime\\": \\"2025-11-04 01:09:27\\",\\n \\"EndTime\\": \\"2024-11-12 14:52:42\\",\\n \\"Executor\\": \\"1827811800526000\\",\\n \\"Status\\": 4,\\n \\"AppName\\": \\"test-app\\"\\n }\\n ],\\n \\"Total\\": 65,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\"\\n}","type":"json"}]',
- 'title' => '获取工作流实例列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\\\n\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkerId\\": 0,\\n \\"Name\\": \\"myWorkflow\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"WorkerType\\": \\"k8s_service\\",\\n \\"Workers\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\",\\n \\"AuthType\\": \\"EDIT\\",\\n \\"Protocol\\": \\"TCP\\",\\n \\"Network\\": \\"{\\\\\\\\\\\\\\"OfficeSiteId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-hangzhou+dir-8801187585\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"VSwitchIds\\\\\\\\\\\\\\":[null]}\\",\\n \\"FailedService\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\"\\n }\\n}","type":"json"}]',
],
- 'DeleteWorkflow' => [
- 'summary' => '删除工作流',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateExecutors' => [
+ 'summary' => '更新执行器',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -16558,60 +10019,37 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227449',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
+ 'abilityTreeNodes' => ['FEATUREmse09FNQO'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'WorkflowId',
+ 'name' => 'WorkerType',
'in' => 'formData',
'schema' => [
- 'title' => '工作流ID',
- 'description' => '工作流ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '10',
+ 'description' => '执行器类型',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'k8s_service',
+ 'enum' => ['xxljob', 'dify_workflow', 'http_domain', 'k8s_service'],
],
],
[
- 'name' => 'DeleteJobs',
+ 'name' => 'Workers',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否删除工作流下的所有任务',
- 'description' => '是否删除工作流下的所有任务',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'required' => false, 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
],
],
'responses' => [
@@ -16621,28 +10059,23 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- **true**：调用成功。'."\n"
+ .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'WorkId' => ['description' => '执行器ID', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'AppGroupId' => ['description' => '任务分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'."\n"],
+ 'AppType' => ['description' => '应用类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'WorkerType' => ['description' => '执行器类型', 'type' => 'string', 'example' => 'k8s_service'],
+ 'Workers' => ['description' => '指定机器列表JSON格式列表', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
+ 'FailedService' => ['description' => '导入失败的k8s服务', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]'],
+ ],
],
],
],
@@ -16650,365 +10083,393 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除工作流',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"WorkId\\": 1,\\n \\"AppGroupId\\": 1,\\n \\"AppType\\": 1,\\n \\"WorkerType\\": \\"k8s_service\\",\\n \\"Workers\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\",\\n \\"FailedService\\": \\"[{\\\\\\"cluster\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"namespace\\\\\\":\\\\\\"xxxxx\\\\\\",\\\\\\"service\\\\\\":\\\\\\"xxxxx\\\\\\"}]\\"\\n }\\n}","type":"json"}]',
+ 'title' => '更新执行器',
+ 'description' => '# 引入增强插件'."\n"
+ ."\n"
+ .'在`pom.xml`文件中添加增强插件以提升Executor的能力。'."\n"
+ ."\n"
+ .'**注意**：请确保该插件在pom中放置在`xxl-job-core` 依赖的**上方**。'."\n"
+ ."\n"
+ .'**详细信息请参考**：[插件版本说明文档](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)',
+ 'changeSet' => [],
],
- 'ListDatasources' => [
- 'summary' => '获取数据源列表',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateJob' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '227432',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
],
'parameters' => [
[
'name' => 'ClusterId',
- 'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'PageNum',
- 'in' => 'query',
+ 'name' => 'AppName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '74'],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test-job'."\n", 'maxLength' => 200],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'test'."\n", 'maxLength' => 300],
+ ],
+ [
+ 'name' => 'RouteStrategy',
+ 'in' => 'formData',
+ 'schema' => ['description' => '路由策略：'."\n"
+ ."\n"
+ .'- 1: 轮询'."\n"
+ .'- 2: 随机'."\n"
+ .'- 3: 第一个'."\n"
+ .'- 4: 最后一个'."\n"
+ .'- 5: 最不经常使用'."\n"
+ .'- 6: 最近最久未使用'."\n"
+ .'- 7: 一致性哈希'."\n"
+ .'- 8: 分片广播', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '9', 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'Parameters',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务参数', 'type' => 'string', 'required' => false, 'example' => 'test'."\n", 'maxLength' => 2000],
+ ],
+ [
+ 'name' => 'MaxConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务并发数'."\n"
+ .'>同一个任务同一时间允许运行的最大实例个数，1表示不允许重复执行。如果超过并发数，会跳过当前调度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'MaxAttempt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务失败重试次数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'AttemptInterval',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务失败重试间隔', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'JobHandler',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'jobhandler名称', 'type' => 'string', 'required' => false, 'example' => 'testJobVoidHandler'."\n", 'maxLength' => 200],
+ ],
+ [
+ 'name' => 'Script',
+ 'in' => 'formData',
+ 'schema' => ['title' => '非BEAN任务，通过该字段配置脚本', 'description' => '非BEAN任务，通过该字段配置脚本', 'type' => 'string', 'required' => false, 'example' => 'echo "hello world"'],
+ ],
+ [
+ 'name' => 'TimeType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '页数',
+ 'description' => '时间类型，目前支持以下几种类型：'."\n"
+ ."\n"
+ .'- -1: none'."\n"
+ .'- 1：cron'."\n"
+ .'- 3：fix_rate'."\n"
+ .'- 5：one_time'."\n"
+ .'- 100:：api',
'type' => 'integer',
'format' => 'int32',
'required' => false,
+ 'docRequired' => false,
'example' => '1',
- 'default' => '1',
+ 'enum' => ['-1', '1', '2', '3', '5', '100'],
],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
+ 'name' => 'TimeExpression',
+ 'in' => 'formData',
+ 'schema' => ['description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
+ ."\n"
+ .'- none：无需填写'."\n"
+ .'- cron：填写标准的cron表达式，支持在线验证。'."\n"
+ .'- api：无需填写'."\n"
+ .'- fixed_rate：填写具体固定频率值，单位s。如30表示每隔30s触发一次。'."\n"
+ .'- one_time: 填写调度时间（yyyy-MM-dd HH:mm:ss）或者时间戳（毫秒），比如"2022-10-10 10:10:00"', 'type' => 'string', 'required' => false, 'example' => '0 0 4 ? * Mon/1'."\n"],
+ ],
+ [
+ 'name' => 'Calendar',
+ 'in' => 'formData',
+ 'schema' => ['description' => '自定义日历', 'type' => 'string', 'required' => false, 'example' => 'workday'],
+ ],
+ [
+ 'name' => 'XAttrs',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'example' => ' {"reponseMode":"streaming"}'],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务执行优先级。目前支持以下几种配置：'."\n"
+ ."\n"
+ .'- 1: 低'."\n"
+ .'- 5: 中'."\n"
+ .'- 10: 高'."\n"
+ .'- 15: 非常高', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '10'],
+ ],
+ [
+ 'name' => 'StartTimeType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '开始时间类型',
+ 'description' => '开始时间类型',
+ 'type' => 'string',
'required' => false,
- 'example' => '10',
- 'default' => '10',
+ 'example' => '1',
+ 'enum' => ['1', '2', '3', '4'],
],
],
[
- 'name' => 'Name',
- 'in' => 'query',
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '调度开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1716902187'],
+ ],
+ [
+ 'name' => 'Timezone',
+ 'in' => 'formData',
+ 'schema' => ['description' => '时区'."\n"
+ .'> 默认使用schedulerx服务器所在时区', 'type' => 'string', 'required' => false, 'example' => 'Hongkong'],
+ ],
+ [
+ 'name' => 'NoticeConfig',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '任务名称。',
- 'type' => 'string',
+ 'title' => '报警配置',
+ 'description' => '通知配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimeoutEnable' => ['description' => '超时报警开关。取值如下：'."\n"
+ ."\n"
+ .'- true：开启'."\n"
+ ."\n"
+ .'- false：关闭', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Timeout' => ['description' => '任务执行超时时间，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90'],
+ 'TimeoutKillEnable' => ['description' => '超时终止本次触发开关。取值如下：'."\n"
+ ."\n"
+ .'- **true**：开启超时终止开关。'."\n"
+ .'- **false**：关闭超时终止开关。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'SuccessNotice' => ['description' => '成功通知开关。取值如下：'."\n"
+ ."\n"
+ .'- true：开启。'."\n"
+ .'- false：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'FailEnable' => ['description' => '失败报警开关。取值如下：'."\n"
+ ."\n"
+ .'- **true**：开启失败报警开关。'."\n"
+ .'- **false**：关闭失败报警开关。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'FailLimitTimes' => ['description' => '连续失败次数。'."\n"
+ .'> 只有连续失败超过配置次数才会收到报警。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'true', 'default' => '1'],
+ 'MissWorkerEnable' => ['description' => '是否开启无可用机器告警。'."\n"
+ .'- **true**：开启无可用机器告警开关。'."\n"
+ .'- **false**：关闭无可用机器告警开关。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'SendChannel' => ['description' => '通知渠道,取值如下：'."\n"
+ .' - 短信：sms'."\n"
+ .' - 电话：phone'."\n"
+ .'- 邮件：mail'."\n"
+ .'- webhook：webhook'."\n"
+ .'> 配置多个通知渠道请用逗号分割', 'type' => 'string', 'required' => false, 'example' => 'webhook,sms,mail,phone'."\n"],
+ 'EndEarlyEnable' => ['title' => '提前结束报警开关', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => ''],
+ 'EndEarly' => ['title' => '提前结束的阈值，单位秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'description' => ''],
+ ],
'required' => false,
- 'example' => '修正券统计数据',
],
],
[
- 'name' => 'Type',
- 'in' => 'query',
+ 'name' => 'NoticeContacts',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Grafana大盘类型，包括：dash-db：大盘 dash-folder：文件夹（可包含大盘）',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '通知联系人配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '-',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactType' => [
+ 'description' => '联系人类型 '."\n"
+ .'>默认配置: 1',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => ['1', '2', '3'],
+ ],
+ 'Name' => ['description' => '联系人名称', 'type' => 'string', 'required' => false, 'example' => 'xiaoming'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'REDIS',
],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
+ 'name' => 'ExecutorBlockStrategy',
+ 'in' => 'formData',
'schema' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
+ 'description' => '客户端阻塞处理策略。'."\n"
+ .'- 1: 单机串行'."\n"
+ .'- 2: 忽略后续调度'."\n"
+ .'- 3: 覆盖之前调度',
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'example' => '10',
+ 'example' => '1',
+ 'enum' => ['1', '2', '3'],
],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
+ 'name' => 'ChildJobId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '子任务id，多个以逗号分隔', 'description' => '子任务id，多个以逗号分隔', 'type' => 'string', 'required' => false, 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'Weight',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务权重', 'description' => '任务权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DependentStrategy',
+ 'in' => 'formData',
'schema' => [
- 'description' => '用来表示当前调用返回读取到的位置，空代表数据已经读取完毕, 第一次查询不需要提供这个参数。',
- 'type' => 'string',
+ 'title' => '依赖策略',
+ 'description' => '依赖策略',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
+ 'example' => '1',
+ 'default' => '1',
+ 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8'],
],
],
],
'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' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- **true**：调用成功。'."\n"
- .'- **false**：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Records' => [
- 'description' => '-',
- 'type' => 'array',
- 'items' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'DatasourceId' => [
- 'description' => '数据源ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '145',
- ],
- 'Name' => [
- 'description' => '任务名',
- 'type' => 'string',
- 'example' => 'job01',
- ],
- 'Description' => [
- 'description' => '任务描述。',
- 'type' => 'string',
- 'example' => 'my first workflow',
- ],
- 'ConnectionParams' => [
- 'description' => '数据源连接参数',
- 'type' => 'string',
- 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}',
- ],
- 'Updater' => [
- 'description' => '更新者。',
- 'type' => 'string',
- 'example' => '1827811800555555',
- ],
- 'Type' => [
- 'description' => '具体发音规则类型。 可选：'."\n"
- ."\n"
- .'- replacement。直接将Word替换为Pronunciation的规则。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'target',
- ],
- ],
- ],
- ],
- 'Total' => [
- 'description' => '总条数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PageNumber' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'MaxResults' => [
- 'description' => '本次读取的最大数据量，默认值为10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'description' => '当符合查询条件的数据未读取完时，服务端会返回nextToken，此时可以使用nextToken继续读取后面的数据。第一次查询不需要提供这个参数。',
- 'type' => 'string',
- 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题', 'type' => 'string', 'example' => '3808cf26-dde2-4286-8503-b0a2cd4065a7'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '更新任务',
+ 'summary' => '更新任务信息。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-04T09:10:29.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-24T09:10:14.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-01-09T06:28:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-17T09:51:37.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"DatasourceId\\": 145,\\n \\"Name\\": \\"job01\\",\\n \\"Description\\": \\"my first workflow\\",\\n \\"ConnectionParams\\": \\"{\\\\\\"host\\\\\\":\\\\\\"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com\\\\\\",\\\\\\"port\\\\\\":3306,\\\\\\"userName\\\\\\":\\\\\\"test01\\\\\\",\\\\\\"database\\\\\\":\\\\\\"test01\\\\\\",\\\\\\"other\\\\\\":{\\\\\\"useSSL\\\\\\":\\\\\\"false\\\\\\"}}\\",\\n \\"Updater\\": \\"1827811800555555\\",\\n \\"Type\\": 0\\n }\\n ],\\n \\"Total\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"eCKqVlS5FKF5EWGGOo8EgQ==\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取数据源列表',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateJob'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3808cf26-dde2-4286-8503-b0a2cd4065a7\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'OperateConnectDatasource' => [
- 'summary' => '连接数据源',
+ 'UpdateJobExecution' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227426',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeCode' => '227437',
+ 'abilityTreeNodes' => ['FEATUREmseP3AH6A'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Type',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源的类型。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'test-app'],
],
[
- 'name' => 'ConnectionParams',
+ 'name' => 'JobExecutionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源连接参数',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}',
- ],
+ 'schema' => ['description' => '任务执行ID。', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120'],
],
[
- 'name' => 'Password',
+ 'name' => 'ScheduleTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据库用户的密码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '***',
- ],
+ 'schema' => ['description' => '调度时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2023-10-01 12:00:00'],
],
],
'responses' => [
@@ -17018,202 +10479,134 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0'],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功'."\n"
+ .'- false：调用失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新任务实例',
+ 'summary' => '更新任务实例',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '测试连接数据源',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'DeleteDatasource' => [
- 'summary' => '删除数据源',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateJobScript' => [
+ 'summary' => '更新任务执行脚本。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227426',
- 'abilityTreeNodes' => [
- 'FEATUREmseWTWX7C',
- ],
+ 'abilityTreeCode' => '227449',
+ 'abilityTreeNodes' => ['FEATUREmseCPRKIU'],
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'DatasourceId',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源ID，可通过接口ListDatasources获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '195',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app'],
+ ],
+ [
+ 'name' => 'ScriptContent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '脚本内容。', 'type' => 'string', 'required' => false, 'example' => '#!/bin/bash'."\n"
+ .'echo "xxl-job: hello shell"'."\n"
+ ."\n"
+ .'echo "脚本位置: $0"'."\n"
+ .'echo "任务参数: $1"'."\n"
+ .'echo "分片序号 = $2"'."\n"
+ .'echo "分片总数 = $3"'."\n"
+ ."\n"
+ .'echo "Good bye!"'."\n"
+ .'exit 0'],
+ ],
+ [
+ 'name' => 'VersionDescription',
+ 'in' => 'formData',
+ 'schema' => ['description' => '脚本版本描述。', 'type' => 'string', 'required' => true, 'example' => 'init version'],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74'],
],
],
'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' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.'."\n",
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'not support update script, please upgrade engine version to 2.2.2+'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF'],
+ 'Success' => ['description' => '是否调用成功。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CF99C381-C8F6-5A8D-8C24-57F46B706D2D\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除数据源',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"not support update script, please upgrade engine version to 2.2.2+\\",\\n \\"RequestId\\": \\"29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '更新任务执行脚本',
+ 'changeSet' => [],
],
- 'UpdateDatasource' => [
- 'summary' => '更新数据源',
+ 'UpdateWorkflow' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -17225,72 +10618,73 @@
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREmse8UT78G',
- ],
+ 'abilityTreeCode' => '227447',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'],
],
[
- 'name' => 'DatasourceId',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源ID，可通过接口ListDatasources获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$'],
+ ],
+ [
+ 'name' => 'WorkflowId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
'name' => 'Name',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '账单拉取-支付宝团购',
- ],
+ 'schema' => ['description' => '工作流名称', 'type' => 'string', 'required' => false, 'example' => 'myWorkflow', 'maxLength' => 32, 'minLength' => 6, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'title' => '',
- 'description' => '数据源描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'None',
- ],
+ 'schema' => ['description' => '工作流描述', 'type' => 'string', 'required' => false, 'example' => 'my first workflow', 'maxLength' => 64],
],
[
- 'name' => 'ConnectionParams',
+ 'name' => 'TimeType',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源连接参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}',
- ],
+ 'schema' => ['description' => '调度类型，目前支持以下几种类型：'."\n"
+ .'- -1: none'."\n"
+ .'- 1：cron'."\n"
+ .'- 100:：api', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Password',
+ 'name' => 'TimeExpression',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据库密码',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2F9e9@a69c!e18b569c8',
- ],
+ 'schema' => ['description' => '时间表达式，根据选择的时间类型设置时间表达式。'."\n"
+ .'- none：无需填写'."\n"
+ .'- cron：填写标准的cron表达式，支持在线验证。'."\n"
+ .'- api：无需填写', 'type' => 'string', 'required' => false, 'example' => '0 0/10 * * * ?'],
+ ],
+ [
+ 'name' => 'Timezone',
+ 'in' => 'formData',
+ 'schema' => ['description' => '时区'."\n"
+ .'> 默认使用schedulerx服务器所在时区', 'type' => 'string', 'required' => false, 'example' => 'GMT+8'],
+ ],
+ [
+ 'name' => 'Calendar',
+ 'in' => 'formData',
+ 'schema' => ['description' => '自定义日历', 'type' => 'string', 'required' => false, 'example' => 'workday'],
+ ],
+ [
+ 'name' => 'MaxConcurrency',
+ 'in' => 'formData',
+ 'schema' => ['description' => '最大并发数'."\n"
+ .'>同一个工作流同一时间允许运行的最大实例个数，1表示不允许重复执行。如果超过并发数，会跳过当前调度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'],
],
],
'responses' => [
@@ -17300,81 +10694,47 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9',
- ],
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter format error',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC'],
+ 'Success' => ['description' => '是否调用成功。'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => '参数错误: %s'],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => '非法请求：%s'],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => '没有权限去执行该操作：%s'],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => '资源不存在：%s'."\n"],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => '系统内部错误：%s'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新工作流',
+ 'summary' => '更新工作流',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新数据源',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'UpdateJobExecution' => [
- 'summary' => '更新任务实例',
+ 'UpdateWorkflowDAG' => [
+ 'summary' => '更新工作流的DAG信息，包含节点坐标和边信息',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -17383,55 +10743,136 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '227437',
- 'abilityTreeNodes' => [
- 'FEATUREmseP3AH6A',
- ],
+ 'abilityTreeCode' => '227447',
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-app',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$'],
],
[
- 'name' => 'JobExecutionId',
+ 'name' => 'WorkflowId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Dag',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '任务执行ID。',
- 'type' => 'string',
+ 'description' => '工作流DAG信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Nodes' => [
+ 'description' => '工作流节点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '节点信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ 'Coordinate' => [
+ 'description' => '节点坐标',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['description' => 'X坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '50'],
+ 'Y' => ['description' => 'Y坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '50'],
+ 'Width' => ['description' => '节点宽度，可以不填', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100'],
+ 'Height' => ['description' => '节点高度，可以不填', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20'],
+ ],
+ 'required' => false,
+ ],
+ 'Content' => ['description' => '逻辑节点表达式', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "logicType": "status_branch",'."\n"
+ .' "conditionResult": {'."\n"
+ .' "successList": ['."\n"
+ .' {'."\n"
+ .' "jobName": "status-job4",'."\n"
+ .' "jobId": "269"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "failedList": ['."\n"
+ .' {'."\n"
+ .' "jobName": "status-job5",'."\n"
+ .' "jobId": "270"'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "dependence": {'."\n"
+ .' "relation": "AND",'."\n"
+ .' "dependList": ['."\n"
+ .' {'."\n"
+ .' "relation": "AND",'."\n"
+ .' "dependItemList": ['."\n"
+ .' {'."\n"
+ .' "jobName": "status-job1",'."\n"
+ .' "jobId": 265,'."\n"
+ .' "status": ['."\n"
+ .' 4'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "jobName": "status-job2",'."\n"
+ .' "jobId": 266,'."\n"
+ .' "status": ['."\n"
+ .' 5'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "relation": "AND",'."\n"
+ .' "dependItemList": ['."\n"
+ .' {'."\n"
+ .' "jobName": "status-job3",'."\n"
+ .' "jobId": 267,'."\n"
+ .' "status": ['."\n"
+ .' 4'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'."\n"
+ .'}'."\n"],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'Edges' => [
+ 'description' => '工作流边列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '边信息，source->target表示边的方向',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['description' => '边起点的任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'],
+ 'Target' => ['description' => '边终点的任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => true,
- 'example' => '1310630367761285120',
],
],
[
- 'name' => 'ScheduleTime',
+ 'name' => 'DagVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '调度时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2023-10-01 12:00:00',
- ],
+ 'schema' => ['description' => '任务流版本号，可调用[ListDAGVersions](~~465989~~)接口获取该参数的值。', 'type' => 'string', 'required' => false, 'example' => '1137005'],
],
],
'responses' => [
@@ -17441,81 +10882,42 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功'."\n"
- .'- false：调用失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter error: content is null.'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC'],
+ 'Success' => ['description' => '请求返回状态。'."\n"
+ .'- true：成功。'."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27B1345D-5F71-5972-8E4C-AABA6C6232F0\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新任务实例',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '更新工作流的DAG信息',
+ 'changeSet' => [],
],
- 'CreateDatasource' => [
- 'summary' => '创建数据源',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateWorkflowDAGVersion' => [
+ 'summary' => '切换工作流DAG版本',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -17524,87 +10926,33 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227447',
- 'abilityTreeNodes' => [
- 'FEATUREmsePN2NBR',
- ],
+ 'abilityTreeNodes' => ['FEATUREmseWTWX7C'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClusterId',
'in' => 'formData',
- 'schema' => [
- 'description' => '集群ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxljob-b6ec1xxxx',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '数据源名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'myDatasouce',
- 'maxLength' => 100,
- 'minLength' => 6,
- 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '数据源名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'my first datasource',
- 'maxLength' => 64,
- 'minLength' => 0,
- ],
+ 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'],
],
[
- 'name' => 'Type',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源类型'."\n"
- .'- 0: MySQL'."\n"
- .'- 1: PostgreSQL',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '0',
- 'enum' => [
- '0',
- '1',
- ],
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$'],
],
[
- 'name' => 'ConnectionParams',
+ 'name' => 'WorkflowId',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据源连接参数，json格式',
- 'type' => 'string',
- 'required' => true,
- 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}'."\n",
- ],
+ 'schema' => ['description' => '工作流ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'Password',
+ 'name' => 'DagVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据库密码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '***',
- ],
+ 'schema' => ['description' => '工作流DAG版本号', 'type' => 'string', 'required' => true, 'example' => 'v1'],
],
],
'responses' => [
@@ -17614,132 +10962,179 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Parameter error: content is null.',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C',
- ],
- 'Success' => [
- 'description' => '是否调用成功。'."\n"
- .'- true：调用成功。'."\n"
- .'- false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '-',
- 'type' => 'object',
- 'properties' => [
- 'DatasourceId' => [
- 'description' => '数据源ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
+ 'Code' => ['description' => '响应码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Parameter check error'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263'],
+ 'Success' => ['description' => '是否调用成功。具体取值如下：'."\n"
+ .'- true：调用成功。'."\n"
+ .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'Parameter error: %s.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'IllegalRequest',
- 'errorMessage' => 'IllegalRequest: %s.',
- ],
+ ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission to perform this operation: %s.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => ''],
],
[
- [
- 'errorCode' => 'NotFound',
- 'errorMessage' => 'Not found: %s.',
- ],
+ ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'InternalError: %s.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter error: content is null.\\",\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DatasourceId\\": 1\\n }\\n}","type":"json"}]',
- 'title' => '创建数据源',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '切换工作流DAG版本',
+ 'changeSet' => [],
],
],
'endpoints' => [
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-shenzhen.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-shenzhen.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-beijing.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-beijing.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.ap-northeast-1.aliyuncs.com', 'endpoint' => 'schedulerx3.ap-northeast-1.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-chengdu.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-chengdu.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-shanghai.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-shanghai.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-guangzhou.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-guangzhou.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-hongkong.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-hongkong.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.ap-southeast-1.aliyuncs.com', 'endpoint' => 'schedulerx3.ap-southeast-1.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'schedulerx3.cn-hangzhou.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-hangzhou.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'schedulerx3.eu-central-1.aliyuncs.com', 'endpoint' => 'schedulerx3.eu-central-1.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'schedulerx3.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'IllegalRequest', 'message' => 'IllegalRequest: %s.', 'http_code' => 401, 'description' => '非法请求：%s'],
+ ['code' => 'InternalError', 'message' => 'InternalError: %s.', 'http_code' => 500, 'description' => '系统内部错误：%s'],
+ ['code' => 'InvalidParameter', 'message' => 'Parameter error: %s.', 'http_code' => 400, 'description' => '参数错误: %s'],
+ ['code' => 'NoPermission', 'message' => 'No permission to perform this operation: %s.', 'http_code' => 403, 'description' => '没有权限去执行该操作：%s'],
+ ['code' => 'NotFound', 'message' => 'Not found: %s.', 'http_code' => 404, 'description' => '资源不存在：%s'."\n"],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'schedulerx3.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'schedulerx3.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'schedulerx3.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'schedulerx3.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'ListApps'],
+ ],
+ 'createdAt' => '2025-12-25T03:50:53.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'schedulerx3.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateJob'],
+ ['description' => '响应参数发生变更', 'api' => 'GetCluster'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetLogEvent'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListJobExecutions'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListJobs'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListScheduleEvent'],
+ ['description' => '请求参数发生变更', 'api' => 'OperateRetryJobExecution'],
+ ['description' => '请求参数发生变更', 'api' => 'OperateStopJobExecution'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateJob'],
+ ],
+ 'createdAt' => '2025-12-24T08:56:33.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'schedulerx3.cn-guangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateJob'],
+ ['description' => '响应参数发生变更', 'api' => 'ListJobs'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateJob'],
+ ],
+ 'createdAt' => '2025-03-24T09:10:22.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'schedulerx3.cn-chengdu.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateJob'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateJob'],
+ ],
+ 'createdAt' => '2025-01-09T06:28:39.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'schedulerx3.cn-hongkong.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateJob'],
+ ['description' => '响应参数发生变更', 'api' => 'ListJobs'],
+ ['description' => '请求参数发生变更', 'api' => 'UpdateJob'],
+ ],
+ 'createdAt' => '2024-12-17T09:52:13.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'schedulerx3.ap-northeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'ListJobs'],
+ ],
+ 'createdAt' => '2024-11-29T02:39:20.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'schedulerx3.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'OperateRetryJobExecution'],
+ ['description' => '请求参数发生变更', 'api' => 'OperateStopJobExecution'],
+ ],
+ 'createdAt' => '2024-11-28T05:41:02.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'schedulerx3.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'GetJobExecutionProgress'],
+ ['description' => '请求参数发生变更', 'api' => 'GetLog'],
+ ['description' => '响应参数发生变更', 'api' => 'ListClusters'],
+ ['description' => '请求参数发生变更', 'api' => 'ListJobExecutions'],
+ ['description' => '请求参数发生变更', 'api' => 'ListScheduleEvent'],
+ ['description' => '请求参数发生变更', 'api' => 'OperateRetryJobExecution'],
+ ['description' => '请求参数发生变更', 'api' => 'OperateStopJobExecution'],
+ ],
+ 'createdAt' => '2024-11-27T12:12:42.000Z',
+ 'description' => '',
],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'schedulerx3.cn-shanghai-finance-1.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduleTimes'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppNames'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobExecutionProgress'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportJobs'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateDesignateExecutors'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduleEvent'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateStopJobExecution'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDesigateInfo'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegionZone'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobExecutionThreadDump'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateRerunJob'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJobs'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApp'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCluster'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCluster'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportJobs'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLog'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlarmEvent'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLables'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCluster'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLogEvent'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExecutors'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApps'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateJob'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusters'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateRetryJobExecution'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateExecuteJob'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobExecutions'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateEnableJobs'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCalendarNames'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCalendar'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCluster'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateDisableJobs'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 17:53:40 +0000