diff options
Diffstat (limited to 'data/en_us/schedulerx3')
| -rw-r--r-- | data/en_us/schedulerx3/2024-06-24/api-docs.php | 19490 |
1 files changed, 7268 insertions, 12222 deletions
diff --git a/data/en_us/schedulerx3/2024-06-24/api-docs.php b/data/en_us/schedulerx3/2024-06-24/api-docs.php index 17f9016..3344ecd 100644 --- a/data/en_us/schedulerx3/2024-06-24/api-docs.php +++ b/data/en_us/schedulerx3/2024-06-24/api-docs.php @@ -1,160 +1,285 @@ <?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' => 'Clusters', + 'children' => ['CreateCluster', 'UpdateCluster', 'DeleteCluster', 'GetCluster', 'ListClusters'], 'type' => 'directory', - 'children' => [ - 'CreateCluster', - 'UpdateCluster', - 'DeleteCluster', - 'GetCluster', - 'ListClusters', - ], + 'title' => 'Clusters', ], [ - 'id' => 199532, - 'title' => 'Applications', + 'children' => ['UpdateApp', 'GetApp', 'DeleteApp', 'ListApps', 'ListAppNames', 'ListLables', 'ListExecutors'], 'type' => 'directory', - 'children' => [ - 'CreateApp', - 'UpdateApp', - 'GetApp', - 'DeleteApp', - 'ListApps', - 'ListAppNames', - 'ListLables', - 'ListExecutors', - ], + 'title' => 'Applications', ], [ - 'id' => 278802, - 'title' => null, + 'children' => ['UpdateExecutors', 'GetExecutorConfig', 'CreateExecutors'], 'type' => 'directory', - 'children' => [ - 'UpdateExecutors', - 'GetExecutorConfig', - 'CreateExecutors', - ], + 'title' => 'Executor', ], [ - 'id' => 199533, - 'title' => 'Jobs', + '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' => 'Jobs', ], [ - 'id' => 199534, - 'title' => 'Job execution', + 'children' => ['GetJobExecution', 'OperateStopJobExecution', 'OperateDesignateExecutors', 'OperateRetryJobExecution', 'OperateExecuteJob', 'GetJobExecutionProgress', 'GetJobExecutionThreadDump', 'ListJobExecutions'], 'type' => 'directory', - 'children' => [ - 'GetJobExecution', - 'OperateStopJobExecution', - 'OperateDesignateExecutors', - 'OperateRetryJobExecution', - 'OperateExecuteJob', - 'GetJobExecutionProgress', - 'GetJobExecutionThreadDump', - 'ListJobExecutions', - ], + 'title' => 'Job execution', ], [ - 'id' => 199500, - 'title' => 'Others', - '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' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateCluster' => [ - 'summary' => 'Creates a cluster.', - 'methods' => [ - 'post', + 'CreateApp' => [ + 'summary' => 'Creates an app.', + '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The app name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'AccessToken', + 'in' => 'formData', + 'schema' => ['description' => 'The access token.', 'type' => 'string', 'maxLength' => 32, 'minLength' => 6, 'pattern' => '^[\\w.-]+$', 'required' => false, 'example' => 'ltk1ZXHv6LvibZypFkPHzRA', 'title' => ''], + ], + [ + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['description' => 'The title of the app.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 1, 'example' => 'Test', 'title' => ''], + ], + [ + 'name' => 'MaxConcurrency', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum concurrency.'."\n" + ."\n" + .'> This parameter specifies the maximum number of task instances that can run concurrently for the app. Task instances that exceed this limit are not discarded. They are queued for execution.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'EnableLog', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether to enable logging.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'LabelRouteStrategy', + 'in' => 'formData', + 'schema' => ['description' => 'The label routing strategy.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AppType', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Application type', + 'description' => 'The app type.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + 'enum' => ['1', '2', '3', '4'], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request, generated by Alibaba Cloud. Use this request ID to troubleshoot issues.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned for the request.', + 'type' => 'object', + 'properties' => [ + 'AppGroupId' => ['description' => 'The app group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'AccessToken' => ['description' => 'The access token.', 'type' => 'string', 'example' => '4a0fae835cd741f3b12376d8a5a8e549v3', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], + ], + [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Create Application', + 'changeSet' => [ + ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'], + ], + ], + ], + 'CreateCalendar' => [ + 'summary' => 'Creates a custom calendar.', + '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' => 'The Cluster ID. You can call the [ListClusters](~~28147~~) operation to query Cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'CalendarName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the calendar.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'workday'], + ], + [ + 'name' => 'Year', + 'in' => 'formData', + 'schema' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2026', 'title' => ''], + ], + [ + 'name' => 'Months', + 'in' => 'formData', + 'schema' => ['description' => 'The days of each month, specified in a JSON array.', 'type' => 'string', 'title' => '', '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' => 'A client token to ensure request idempotence. Generate a unique value for this parameter on your client. The token can contain only ASCII characters. Note: If you do not specify this parameter, the system automatically uses the Request ID as the client token. The Request ID may be different for each request.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned for the request.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B880122A-B0E4-52E8-8F54-87DB7779EB74'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'CalendarName is already existed', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- `true`: The call was successful.'."\n" + ."\n" + .'- `false`: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], + ], + [ + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], ], - 'schemes' => [ - 'https', + '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' => 'Create Calendar ', + 'description' => 'Creates a custom calendar for SchedulerX.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateCluster' => [ + 'summary' => 'Creates a cluster.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -167,94 +292,69 @@ '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' => 'The name of the cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'VpcId', 'in' => 'formData', - 'schema' => [ - 'title' => 'VPC id', - 'description' => 'VPC id', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-aa1a18236n90rqhuhhnhh', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the VPC.', 'type' => 'string', 'required' => false, 'example' => ''], ], [ 'name' => 'VSwitches', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '交换机', - 'description' => '', + 'title' => '', + 'description' => 'The information about the vSwitches.', 'type' => 'array', 'items' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-j', - ], - 'VSwitchId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-2ze745n3r2sfqtahhubpl', - ], + 'ZoneId' => ['description' => 'The zone ID of the vSwitch.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], - 'required' => true, + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => true, + 'required' => false, + 'example' => '', ], ], [ 'name' => 'ClusterSpec', 'in' => 'formData', 'schema' => [ - 'title' => '集群规格，可选规格如下：'."\n" - .'1、开发版：scx.dev.x1'."\n" - .'2、专业版：scx.small.x2、scx.medium.x1、scx.medium.x2', - 'description' => '', + 'title' => '', + 'description' => 'The cluster specification. Valid values:'."\n" + .'- scx.dev.x1'."\n" + .'- scx.small.x1'."\n" + .'- scx.small.x2'."\n" + .'- scx.medium.x1'."\n" + .'- scx.medium.x2.', 'type' => 'string', - 'required' => true, - 'example' => 'scx.dev.x1', - 'enum' => [ - 'scx.dev.x1', - 'scx.small.x1', - 'scx.small.x2', - 'scx.medium.x1', - 'scx.medium.x2', - ], + 'required' => false, + 'enum' => ['scx.dev.x1', 'scx.small.x1', 'scx.small.x2', 'scx.medium.x1', 'scx.medium.x2'], + 'example' => '', ], ], [ 'name' => 'EngineType', 'in' => 'formData', 'schema' => [ - 'title' => '引擎类型，可选类型：xxljob', - 'description' => '', + 'title' => '', + 'description' => 'The engine type. Valid values: xxljob.', 'type' => 'string', - 'required' => true, - 'example' => 'xxljob', - 'enum' => [ - 'xxljob', - ], + 'required' => false, + 'enum' => ['xxljob'], + 'example' => '', ], ], [ @@ -262,172 +362,130 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'title' => '标签列表，最多包含20个子项', + 'title' => '', + 'description' => 'The list of tags. A maximum of 20 tags are supported.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '标签值', - 'type' => 'string', - ], - 'Key' => [ - 'title' => '标签键', - 'type' => 'string', - ], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => ''], + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 20, + 'example' => '', ], ], [ 'name' => 'ChargeType', 'in' => 'formData', 'schema' => [ - 'title' => '计费类型', + 'title' => '', + 'description' => 'The billing type.', 'type' => 'string', 'example' => 'POSTPAY', 'default' => 'POSTPAY', - 'enum' => [ - 'PREPAY', - 'POSTPAY', - ], + 'enum' => ['PREPAY', 'POSTPAY'], ], ], [ 'name' => 'PricingCycle', 'in' => 'formData', 'schema' => [ - 'title' => '定价周期', + 'title' => '', + 'description' => 'The pricing cycle.', 'type' => 'string', 'example' => 'Year', 'default' => 'Month', - 'enum' => [ - 'Year', - 'Month', - ], + 'enum' => ['Year', 'Month'], ], ], [ 'name' => 'Duration', 'in' => 'formData', - 'schema' => [ - 'title' => '持续时间', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '9', - 'minimum' => '1', - 'example' => '3', - 'default' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The duration.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '9', 'minimum' => '1', 'example' => '3', 'default' => '1'], + ], + [ + 'name' => 'ClusterType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The cluster type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], + [ + 'name' => 'Source', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => 'schedulerx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'JSONResult', - 'description' => '-', + 'title' => '', + 'description' => 'JSONResult.', 'type' => 'object', 'properties' => [ 'Data' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '229317760970086', - ], - 'ClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxljob-b21969c2309', - ], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => ''], ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'INVALID_PARAMETER', - ], - 'Success' => [ - 'title' => '是否成功(前端要使用)', 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '错误消息', - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.'."\n", - ], - 'RequestId' => [ - 'title' => '请求唯一标识', - 'description' => '', - 'type' => 'string', - 'example' => 'B8733786-C045-59F1-8D79-99A52863F62D', + 'title' => '', + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => ''], + 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => ''], + 'Success' => ['title' => '', 'description' => 'The status of the request. Valid values:'."\n" + .'- true: The request was successful.'."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => ''], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => ''], + 'RequestId' => ['title' => '', 'description' => 'The request ID. Alibaba Cloud generates a unique ID for each request.'."\n" + .'You can use this ID for troubleshooting.', 'type' => 'string', 'example' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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' => 'CreateCluster', - ], - 'UpdateCluster' => [ - 'summary' => 'Updates a cluster.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a cluster', + 'changeSet' => [ + ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-04T09:16:51.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCluster'], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"OrderId\\": 0,\\n \\"ClusterId\\": \\"\\"\\n },\\n \\"Code\\": 0,\\n \\"ErrorCode\\": \\"\\",\\n \\"Success\\": false,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + ], + 'CreateContact' => [ + 'summary' => '', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -436,127 +494,92 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-c20f7ec9a78', - ], + 'schema' => ['description' => '联系人名称（用户自定义，用于展示），同一用户下不可重名', 'type' => 'string', 'required' => true, 'maxLength' => 100, 'minLength' => 1, 'example' => '陈睿', 'title' => ''], ], [ - 'name' => 'ClusterName', + 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => '渠道大类，当前支持 IM', 'type' => 'string', - 'required' => false, - 'example' => 'xx-test-1107', - 'maxLength' => 64, - 'minLength' => 1, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + 'required' => true, + 'enum' => ['IM', 'WEBHOOK', 'SMS', 'MAIL'], + 'example' => 'IM', + 'title' => '', ], ], [ - 'name' => 'IpWhitelist', + 'name' => 'Config', 'in' => 'formData', - 'schema' => [ - 'title' => '实例级别ip白名单', - 'type' => 'string', - '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"}]}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EEF9AF15-AEEF-5E59-BF7B-BCBB119DC53F', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'Success' => [ + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['description' => '新建联系人的 id，后续 Update/Delete 时使用', 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'UpdateCluster', + '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' => 'Deletes a cluster.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDatasource' => [ + 'summary' => 'Create a data source ', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -565,803 +588,672 @@ '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' => 'Cluster ID. ', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'Datasource Name ', 'type' => 'string', 'required' => true, 'maxLength' => 100, 'minLength' => 6, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'example' => 'myDatasouce', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'Datasource Name ', 'type' => 'string', 'required' => false, 'maxLength' => 64, 'minLength' => 0, 'example' => 'my first datasource', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'formData', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Data Source Type '."\n" + .'- 0: MySQL '."\n" + .'- 1: PostgreSQL ', + 'type' => 'integer', + 'format' => 'int32', 'required' => true, - 'example' => 'xxljob-a1804a3226d', + 'example' => '0', + 'enum' => ['0', '1'], + 'title' => '', ], ], + [ + 'name' => 'ConnectionParams', + 'in' => 'formData', + 'schema' => ['description' => 'Connection parameters of the data source, in JSON format ', 'type' => 'string', 'required' => true, 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}'."\n", 'title' => ''], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => ['description' => 'Database password ', 'type' => 'string', 'required' => true, 'example' => '***', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response ', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the current request. This unique identifier is generated by Alibaba Cloud for the request and can be used for troubleshooting and problem identification. ', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. '."\n" + .'- true: The invocation succeeded. '."\n" + .'- false: The invocation failed. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '- ', + 'type' => 'object', + 'properties' => [ + 'DatasourceId' => ['description' => 'DataSource ID ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a data source ', + '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' => 'DeleteCluster', + '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"}]', + 'translator' => 'machine', ], - 'GetCluster' => [ - 'summary' => 'Queries the details of a cluster.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateExecutorGroup' => [ + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-d6a5243b6fa', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'group1', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'group1', 'title' => ''], + ], + [ + 'name' => 'WorkerType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'openclaw', 'title' => ''], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'HTTPS', 'title' => ''], + ], + [ + 'name' => 'Network', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'public', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'api_key', 'title' => ''], + ], + [ + 'name' => 'ApiKey', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'HfGUG/Qf8qRCCWlv5RT6WA==', 'title' => ''], + ], + [ + 'name' => 'Workers', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '[{"address":"http://47.111.188.191:18789"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'], + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'Parameter format error', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ - 'ClusterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxljob-e0d018c6df8', - ], - 'ClusterName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxl-job-test-1730427575152', - ], - 'ClusterSpec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'scx.small.x2', - ], - 'ProductType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'EngineType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxljob', - ], - 'EngineVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.0', - ], - 'Status' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '', - ], - 'ChargeType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'KubeConfig' => [ - 'description' => '', - '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' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-k', - ], - 'VSwitchId' => [ - 'description' => '', - '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' => '最大支持的工作流个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'WorkflowNum' => [ - 'title' => '当前工作流个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'IpWhitelist' => [ - 'title' => 'ip白名单，多个以英文逗号分隔', - 'type' => 'string', - 'example' => '192.168.1.0/24', - ], - 'Tags' => [ - 'type' => 'object', - ], + 'WorkerId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => 'ins-95mfvqrtg6fkijt1uko000', 'title' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'example' => 'myWorkflow', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'example' => 'my first workflow', 'title' => ''], + 'WorkerType' => ['type' => 'string', 'description' => '', 'example' => 'k8s_service', 'title' => ''], + 'Workers' => ['type' => 'string', 'description' => '', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], + 'AuthType' => ['type' => 'string', 'description' => '', 'example' => 'md5_spell', 'title' => ''], + 'Protocol' => ['type' => 'string', 'description' => '', 'example' => 'All', 'title' => ''], + 'Network' => ['type' => 'string', 'description' => '', 'example' => 'NORMAL', 'title' => ''], + 'FailedService' => ['type' => 'string', 'description' => '', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'summary' => '', + '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' => 'GetCluster', + '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' => 'Queries a list of instances.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateExecutors' => [ + 'summary' => 'Imports one or more executors.', + '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' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'type' => 'string', - ], - 'Key' => [ - 'type' => 'string', - ], - ], - ], - 'maxItems' => 21, - ], + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'query', + 'name' => 'WorkerType', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The worker type. The only valid value is `k8s_service`.', 'type' => 'string', - 'required' => false, - 'example' => 'xxljob-d6a5243b6fa', + 'required' => true, + 'enum' => ['xxljob', 'dify_workflow', 'http_domain', 'k8s_service'], + 'example' => 'k8s_service', + 'title' => '', ], ], [ - 'name' => 'ClusterName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cluster-test', - ], + 'name' => 'Workers', + 'in' => 'formData', + 'schema' => ['description' => 'A JSON string that contains an array of workers.', 'type' => 'string', 'required' => true, 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589', - ], - 'Message' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Parameter error: content is null.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- true: The request succeeded.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Records' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '运行状态 1. 创建中 2. 运行中 3. 重启中 4. 销毁中 5.创建失败 6.停机', - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'xxljob-c20f7ec9a78', - ], - 'InternetDomain' => [ - 'title' => '访问方式 公网 ', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-29 15:56:36', - ], - 'ProductType' => [ - 'title' => '产品版本 1 开发版 2 专业版', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ClusterSpec' => [ - 'title' => '实例规格', - 'description' => '', - 'type' => 'string', - 'example' => 'scx.small.x2', - ], - 'SpInstanceId' => [ - 'type' => 'string', - ], - 'VpcId' => [ - 'description' => 'VPC ID', - 'type' => 'string', - 'example' => 'vpc-bp1fxort6ag5h9752i305', - ], - 'ChargeType' => [ - 'description' => '', - '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' => '', - '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' => 'The ID of the worker. You can obtain this ID by calling the [ListWorkerResource](~~2712224~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => 'ins-95mfvqrtg6fkijt1uko000', 'title' => ''], + 'AppGroupId' => ['description' => 'The App Group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'test-app'."\n", 'title' => ''], + 'AppType' => ['description' => 'The application type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WorkerType' => ['description' => 'The worker type.', 'type' => 'string', 'example' => 'k8s_service', 'title' => ''], + 'Workers' => ['description' => 'A JSON string that represents the list of imported workers.', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], + 'FailedService' => ['description' => 'A list of Kubernetes Services that failed to import.', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Manually import executor', + 'description' => 'Imports one or more executors.', + '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' => 'ListClusters', + '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' => 'Creates an application.', - '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The node name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 200, 'minLength' => 1, 'example' => 'test-job', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The node description.', 'type' => 'string', 'required' => false, 'maxLength' => 300, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'JobType', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The node type.', 'type' => 'string', 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', + 'docRequired' => true, + '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', + ], + 'example' => 'xxljob', + 'title' => '', ], ], [ - 'name' => 'AppName', + 'name' => 'RouteStrategy', + 'in' => 'formData', + 'schema' => ['description' => 'The routing strategy. Valid values:'."\n" + .'- 1: round robin'."\n" + .'- 2: random'."\n" + .'- 3: first'."\n" + .'- 4: last'."\n" + .'- 5: least frequently used'."\n" + .'- 6: least recently used'."\n" + .'- 7: consistent hashing'."\n" + .'- 8: shard broadcast', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '9', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => ['description' => 'The node parameters.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'MaxConcurrency', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of concurrent instances.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxAttempt', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of retry attempts upon failure. Set this parameter based on your business requirements.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'AttemptInterval', + 'in' => 'formData', + 'schema' => ['description' => 'The retry interval upon failure. Unit: seconds. Default value: 30.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'JobHandler', + 'in' => 'formData', + 'schema' => ['description' => 'The JobHandler name.', 'type' => 'string', 'required' => false, 'example' => 'testJobVoidHandler', 'title' => ''], + ], + [ + 'name' => 'Script', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The script content for non-BEAN node types. Use this field to pass the script content.', 'type' => 'string', 'example' => 'echo "hello world"', 'required' => false], + ], + [ + 'name' => 'TimeType', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The time type. Valid values:'."\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_-]+$', + 'enum' => ['-1', '1', '2', '3', '5', '100'], + 'example' => '-1', + 'title' => '', ], ], [ - 'name' => 'AccessToken', + 'name' => 'TimeExpression', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The time expression. Set this parameter based on the selected time type.'."\n" + .'- **none**: no value required.'."\n" + .'- **cron**: a standard cron expression. Online verification is supported.'."\n" + .'- **api**: no value required.'."\n" + .'- **fixed_rate**: a fixed frequency value in seconds. For example, 200 indicates that the node is triggered every 200 seconds.'."\n" + .'- **one_time**: a scheduling time in the yyyy-MM-dd HH:mm:ss format or a timestamp in milliseconds. For example, "2022-10-10 10:10:00".', 'type' => 'string', 'required' => false, - 'example' => 'ltk1ZXHv6LvibZypFkPHzRA', - 'maxLength' => 32, - 'minLength' => 6, - 'pattern' => '^[\\w.-]+$', + 'enum' => [], + 'example' => '0 0 4 ? * Mon/1', + 'title' => '', ], ], [ - 'name' => 'Title', + 'name' => 'Calendar', + 'in' => 'formData', + 'schema' => ['description' => 'The custom calendar. This parameter is available only for the cron time type.', 'type' => 'string', 'required' => false, 'example' => 'workday', 'title' => ''], + ], + [ + 'name' => 'Timezone', + 'in' => 'formData', + 'schema' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'GMT+8', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'StartTimeType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The start time type.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'enum' => ['1', '2', '3', '4'], + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1701310327000', 'title' => ''], + ], + [ + 'name' => 'XAttrs', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The extended attributes. This parameter is required for K8s node types.'."\n" + .'Job node: {"resource":"job"}'."\n" + .'Shell node: {"image":"busybox","resource":"shell"}', 'type' => 'string', - 'required' => true, - 'example' => '', - 'maxLength' => 64, - 'minLength' => 1, + 'example' => '{"resource":"job"}', + 'enum' => [], + 'required' => false, ], ], [ - 'name' => 'MaxConcurrency', + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => ['description' => 'The priority. Valid values:'."\n" + .'- 1: low'."\n" + .'- 5: medium'."\n" + .'- 10: high'."\n" + .'- 15: very high', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'NoticeConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The notification configuration.', + 'type' => 'object', + 'properties' => [ + 'TimeoutEnable' => ['description' => 'Specifies whether to enable timeout alerting. Valid values:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + ."\n" + .'- **false**: Disabled.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'default' => '7200', 'required' => false, 'example' => '30', 'title' => ''], + 'TimeoutKillEnable' => ['description' => 'Specifies whether to enable timeout termination. Valid values:'."\n" + ."\n" + .'- **true**: Timeout termination is enabled.'."\n" + .'- **false**: Timeout termination is disabled.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + 'SuccessNotice' => ['description' => 'Specifies whether to enable success notification. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'FailEnable' => ['description' => 'Specifies whether to enable failure alerting. Valid values:'."\n" + ."\n" + .'- **true**: Failure alerting is enabled.'."\n" + .'- **false**: Failure alerting is disabled.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + 'FailLimitTimes' => ['description' => 'The number of consecutive failures.'."\n" + .'> An alert is sent only when the number of consecutive failures exceeds the configured value.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + 'MissWorkerEnable' => ['description' => 'Specifies whether to enable alerting when no workers are available. Valid values:'."\n" + .'- **true**: Alerting for no available workers is enabled.'."\n" + .'- **false**: Alerting for no available workers is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'SendChannel' => ['description' => 'The notification channel. Valid values:'."\n" + .'- sms: text message'."\n" + .'- phone: phone call'."\n" + .'- mail: email'."\n" + .'- webhook: webhook'."\n" + .'> Separate multiple notification channels with commas.', 'type' => 'string', 'required' => false, 'example' => 'mail', 'title' => ''], + 'EndEarlyEnable' => ['title' => '', 'type' => 'boolean', 'default' => 'false', 'description' => '', 'required' => false, 'example' => ''], + 'EndEarly' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => '', 'required' => false], + ], 'required' => false, - 'example' => '10', + 'example' => '1', ], ], [ - 'name' => 'EnableLog', + 'name' => 'NoticeContacts', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'boolean', + 'description' => 'The notification contact configuration.', + 'type' => 'array', + 'items' => [ + 'description' => '.', + 'type' => 'object', + 'properties' => [ + 'ContactType' => [ + 'description' => 'The Notification Recipient type. Valid values:'."\n" + ."\n" + .'- 1: alert contact'."\n" + ."\n" + .'- 2: alert contact group', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['1', '2', '3'], + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'Name' => ['description' => 'The name of the alert contact or alert contact group.', 'type' => 'string', 'required' => false, 'example' => 'xiaoming', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'LabelRouteStrategy', + 'name' => 'ExecutorBlockStrategy', 'in' => 'formData', 'schema' => [ + 'description' => 'The client-side blocking strategy. Valid values:'."\n" + .'- 1: serial execution on a single machine'."\n" + .'- 2: ignore subsequent scheduling'."\n" + .'- 3: override previous scheduling', 'type' => 'integer', 'format' => 'int32', + 'example' => '1', + 'enum' => ['1', '2', '3'], + 'required' => false, + 'title' => '', ], ], [ - 'name' => 'AppType', + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'title' => '应用类型', + 'description' => 'The node status. Default value: enabled. Valid values:'."\n" + .'- 0: disabled'."\n" + .'- 1: enabled', 'type' => 'integer', 'format' => 'int32', + 'enum' => ['0', '1'], 'required' => false, 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'ChildJobId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The child node IDs. Separate multiple IDs with commas.', 'type' => 'string', 'example' => '1,2', 'required' => false], + ], + [ + 'name' => 'Weight', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The node weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + ], + [ + 'name' => 'DependentStrategy', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The dependency strategy.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', 'default' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', + 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8'], + 'required' => false, + ], + ], + [ + 'name' => 'Coordinate', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The node coordinate in the workflow.', + 'type' => 'object', + 'properties' => [ + 'X' => ['title' => '', 'description' => 'The X coordinate.', 'type' => 'number', 'format' => 'float', 'example' => '100.0', 'required' => false], + 'Y' => ['title' => '', 'description' => 'The Y coordinate.', 'type' => 'number', 'format' => 'float', 'example' => '100.0', 'required' => false], + 'Width' => ['title' => '', 'description' => 'The width.', 'type' => 'number', 'format' => 'float', 'example' => '100.0', 'required' => false], + 'Height' => ['title' => '', 'description' => 'The height.', 'type' => 'number', 'format' => 'float', 'example' => '50.0', 'required' => false], ], + 'required' => false, + 'example' => '', ], ], ], @@ -1371,94 +1263,66 @@ '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' => '', - 'type' => 'string', - 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => '-', 'type' => 'object', 'properties' => [ - 'AppGroupId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'AccessToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4a0fae835cd741f3b12376d8a5a8e549v3', - ], + 'JobId' => ['description' => 'The node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '74', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Create a node', + 'summary' => 'Creates a node.', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-04T09:10:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-20T09:00:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-24T09:10:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-09T06:28:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-17T09:51:37.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'CreateApp', - ], - 'UpdateApp' => [ - 'summary' => 'Updates an application group.', - 'methods' => [ - 'post', - ], - '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' => [], @@ -1467,367 +1331,154 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - 'maxLength' => 64, - 'minLength' => 1, - 'pattern' => '^[0-9a-zA-Z_-]+$', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxl-job-executor-sample', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', 'title' => ''], ], [ - 'name' => 'AccessToken', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f312159702f4469585586ed5a6904163v3', - 'maxLength' => 32, - 'minLength' => 6, - 'pattern' => '^[\\w.-]+$', - ], + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => true, 'example' => 'my-workflow', 'maxLength' => 100, 'minLength' => 6, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'title' => ''], ], [ - 'name' => 'Title', + 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - 'maxLength' => 64, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The workflow description.', 'type' => 'string', 'required' => false, 'example' => 'my first workflow for data analyse', 'maxLength' => 64, 'minLength' => 0, 'title' => ''], ], [ - 'name' => 'MaxConcurrency', + 'name' => 'TimeType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The schedule type. Valid values:'."\n" + ."\n" + .'- -1: none<br>'."\n" + ."\n" + .'- 1: cron<br>'."\n" + ."\n" + .'- 100: api', 'type' => 'integer', 'format' => 'int32', 'required' => false, - 'example' => '10', + 'default' => '-1', + 'enum' => ['-1', '1', '100'], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'EnableLog', + 'name' => 'TimeExpression', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The time expression, which depends on the `TimeType` parameter.'."\n" + ."\n" + .'- **none**: This parameter is not required.'."\n" + ."\n" + .'- **cron**: Enter a standard cron expression. Online validation is supported.'."\n" + ."\n" + .'- **api**: This parameter is not required.', 'type' => 'string', 'required' => false, 'example' => '0 0 4 ? * Mon/1'."\n", 'title' => ''], ], [ - 'name' => 'LabelRouteStrategy', + 'name' => 'Calendar', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + 'schema' => ['description' => 'The custom calendar. This parameter applies only when `TimeType` is `cron`.', 'type' => 'string', 'required' => false, 'example' => 'workday', 'title' => ''], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], - ], - [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + 'name' => 'Timezone', + 'in' => 'formData', + 'schema' => ['description' => 'The time zone for the schedule.', 'type' => 'string', 'required' => false, 'example' => 'GMT+8', 'title' => ''], ], - ], - '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' => 'UpdateApp', - ], - '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' => 'The maximum concurrency for the workflow.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-d6a5243b6fa', - ], + 'name' => 'Status', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the workflow. By default, the workflow is disabled. Valid values:'."\n" + ."\n" + .'- 0: Disabled'."\n" + ."\n" + .'- 1: Enabled', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'A unique client token to ensure request idempotence. The token must contain only ASCII characters. If you omit this parameter, the system uses the RequestId as the ClientToken. The RequestId is unique to each request.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Not found: appName not found.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['description' => 'A unique identifier for the request, generated by Alibaba Cloud. Use this Request ID to troubleshoot issues.', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LabelRouteStrategy' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'AppType' => [ - 'title' => '应用类型', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a pipeline ', + 'summary' => 'Creates a workflow.', + '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"}]', + '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' => 'Deletes an application group.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Deletes an App Group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1840,896 +1491,365 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227426', - 'abilityTreeNodes' => [ - 'FEATUREmseWTWX7C', - ], + 'abilityTreeNodes' => ['FEATUREmseWTWX7C'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The name of the App Group.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request, generated by Alibaba Cloud for troubleshooting.', 'type' => 'string', 'example' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'DeleteApp', - ], - 'ListApps' => [ - 'summary' => 'Queries a list of applications.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'Delete Application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'], + ], ], + ], + 'DeleteCalendar' => [ + 'summary' => 'Deletes the specified calendar.', + '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' => '', - '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'name' => 'CalendarName', + 'in' => 'formData', + 'schema' => ['description' => 'The calendar name.', 'type' => 'string', 'title' => '', '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' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.'."\n", - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'Records' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'http://28.5.128.3:80', - ], - 'MaxJobs' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - 'title' => '该字段废弃', - 'deprecated' => true, - ], - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LabelRouteStrategy' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'AppType' => [ - 'title' => '应用类型', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WorkerRegistry' => [ - 'title' => '手动注册执行器类型', - 'type' => 'string', - 'example' => 'k8s_service', - ], - 'WorkflowNum' => [ - 'title' => '当前工作流数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'default' => '0', - ], - ], - ], - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '总条数', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Delete Calendar', + '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' => 'ListApps', ], - 'ListAppNames' => [ - 'summary' => 'Obtains a list of application names.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteCluster' => [ + 'summary' => 'Deletes a cluster.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], - ], - [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3881C59F-59F1-5B2E-8110-7D689CA9B207', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '.', - 'type' => 'array', - 'items' => [ - 'description' => '.', - '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' => '', - 'type' => 'string', - 'example' => 'test-app'."\n", - ], - 'AppType' => [ - 'title' => '应用类型', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WorkerRegistry' => [ - 'title' => '手动注册执行器类型', - 'type' => 'string', - 'example' => 'k8s_service', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID generated for the request. If you encounter an issue, provide this ID for troubleshooting.', 'type' => 'string', 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Release and delete a cluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCluster'], + ], ], - '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' => 'ListAppNames', ], - 'ListLables' => [ - 'summary' => 'Obtains a list of tags of an executor.', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '15', - ], + 'name' => 'ContactName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => '黄永丰', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - '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' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'ListLables', + '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' => 'Queries a list of executors.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteDatasource' => [ + 'summary' => 'Delete data source ', + '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Cluster ID. ', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'Label', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'DataSource ID, which can be obtained by invoking the ListDatasources API. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '195', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response ', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'Address' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://192.168.1.10:9999/', - ], - 'Ip' => [ - 'description' => '', - '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' => '任务权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], + 'RequestId' => ['description' => 'ID of the request ', 'title' => 'ID of the request ', 'type' => 'string', 'example' => 'CF99C381-C8F6-5A8D-8C24-57F46B706D2D'], + 'Code' => ['description' => 'Response code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. '."\n" + .'- true: The invocation succeeded. '."\n" + .'- false: The invocation failed. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete data source ', + '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' => 'ListExecutors', + '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"}]', + 'translator' => 'machine', ], - 'UpdateExecutors' => [ - 'summary' => '更新执行器', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteExecutorGroup' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2738,312 +1858,159 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmse09FNQO', - ], + 'abilityTreeNodes' => ['FEATUREmse09FNQO'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-a1804a3226d', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], - ], - [ - 'name' => 'WorkerType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'k8s_service', - 'enum' => [ - 'xxljob', - 'dify_workflow', - 'http_domain', - 'k8s_service', - ], - ], - ], - [ - 'name' => 'Workers', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'description' => '', 'example' => '83163', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'WorkId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AppGroupId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1'."\n", - ], - 'AppType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WorkerType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'k8s_service', - ], - 'Workers' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', - ], - 'FailedService' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', - ], - ], - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'], + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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"}]', + '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' => 'Deletes multiple jobs in a batch.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-a1804a3226d', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'JobIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The IDs of the jobs to delete.', + 'type' => 'array', + 'items' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74', 'title' => ''], 'required' => true, - 'example' => 'test-app', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'string', - 'example' => '[{"cluster":"c2c619b5129e0400fa3df263b249622aa","namespace":"default","service":"xxljob-http-demo1-svc"}]', - ], - 'ExecutorType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'k8s_service', - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. An error message is returned if the request is unsuccessful.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request and can be used for troubleshooting.', 'type' => 'string', 'example' => '91143E1D-E235-5BE0-9364-C2EE28FFB5A6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Batch delete jobs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJobs'], + ], ], - '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"}]', ], - 'CreateExecutors' => [ - 'summary' => '添加执行器', + 'DeleteWorkflow' => [ + 'summary' => 'Deletes a Workflow.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3052,2201 +2019,1759 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The Application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkerType', + 'name' => 'WorkflowId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'k8s_service', - 'enum' => [ - 'xxljob', - 'dify_workflow', - 'http_domain', - 'k8s_service', - ], - ], + 'schema' => ['description' => 'The Workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Workers', + 'name' => 'DeleteJobs', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', - ], + 'schema' => ['description' => 'Specifies whether to delete all Jobs in the Workflow.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'WorkerId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'ins-95mfvqrtg6fkijt1uko000', - ], - 'AppGroupId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', - ], - 'FailedService' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Delete pipeline', + '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 \\"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"}]', ], - 'SyncJobs' => [ - 'summary' => '同步任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteWorkflows' => [ + 'summary' => 'Deletes one or more workflows.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-00ed7f0d742b1', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d', 'title' => ''], ], [ - 'name' => 'OriginalAppName', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-source', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobIds', + 'name' => 'WorkflowIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'A list of workflow IDs to delete.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '56', - ], + 'items' => ['description' => 'A workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], 'required' => true, 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TargetClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-008bfb1541111', - ], - ], - [ - 'name' => 'TargetAppName', + 'name' => 'DeleteJobs', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-target', - ], + 'schema' => ['description' => 'If set to `true`, all jobs within the specified workflows are also deleted.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Not found: appName not found.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code of the request. A value of `200` indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID for the request. Use it to troubleshoot issues.', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Batch delete pipelines ', + '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"}]', ], - 'CreateJob' => [ - 'summary' => 'Creates a job.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ExportJobs' => [ + 'summary' => 'Exports job information in bulk.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The cluster 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' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'JobIds', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'A list of job IDs.', + 'type' => 'array', + 'items' => ['description' => 'A job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74', 'title' => ''], 'required' => false, - 'example' => 'test', - 'maxLength' => 300, - ], - ], - [ - 'name' => 'JobType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxljob', - 'enum' => [ - 'xxljob', - ], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RouteStrategy', + 'name' => 'ExportJobType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The type of jobs to export. The default value is 1.', 'type' => 'integer', 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9', - 'minimum' => '1', 'example' => '1', 'default' => '1', - ], - ], - [ - 'name' => 'Parameters', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', + 'enum' => ['1'], 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'MaxConcurrency', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'title' => '', ], ], - [ - 'name' => 'MaxAttempt', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'default' => '0', - ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The API response body.', '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", 'title' => ''], ], - [ - 'name' => 'AttemptInterval', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'default' => '30', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - 'name' => 'JobHandler', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testJobVoidHandler', - 'maxLength' => 200, - 'minLength' => 1, - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], - [ - 'name' => 'Script', - 'in' => 'formData', - 'schema' => [ - 'title' => '非BEAN任务类型，通过该字段传脚本内容', - 'type' => 'string', - 'example' => 'echo "hello world"', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - 'name' => 'TimeType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '-1', - 'enum' => [ - '-1', - '1', - '3', - '5', - '100', - ], - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], - [ - 'name' => 'TimeExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0 4 ? * Mon/1', - 'enum' => [], - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], - [ - 'name' => 'Calendar', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workday', - ], + ], + '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' => 'Batch Export Job ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportJobs'], ], + ], + ], + 'ExportWorkflows' => [ + 'summary' => 'Exports the definitions of one or more Workflows in JSON format. The exported data includes the basic information, all Nodes, and the Directed Acyclic Graph (DAG) dependencies for each Workflow.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Timezone', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GMT+8', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227429', + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'StartTimeType', + 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间类型', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - ], - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the cluster where the Workflow is located.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'], ], [ - 'name' => 'StartTime', + 'name' => 'WorkflowId', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'An array of Workflow IDs to export.', + 'type' => 'array', + 'items' => ['description' => 'A Workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], 'required' => false, - 'example' => '1701310327000', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Priority', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '5', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], - [ - 'name' => 'NoticeConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimeoutEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - 'Timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - 'default' => '7200', - ], - 'TimeoutKillEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - 'SuccessNotice' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'FailEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - 'FailLimitTimes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - 'MissWorkerEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'SendChannel' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mail', - ], - 'EndEarlyEnable' => [ - 'title' => '提前结束告警开关', - 'type' => 'boolean', - 'default' => 'false', - ], - 'EndEarly' => [ - 'title' => '提前结束阈值，单位秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - 'required' => false, - 'title' => '报警配置', - ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'A JSON string that contains an array of the exported Workflow definitions.', '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"}]}]', 'title' => ''], ], - [ - 'name' => 'NoticeContacts', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '.', - 'type' => 'object', - 'properties' => [ - 'ContactType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '1', - ], - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xiaoming', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - 'name' => 'ExecutorBlockStrategy', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'enum' => [ - '1', - '2', - '3', - ], - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '0', - '1', - ], - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - 'name' => 'ChildJobId', - 'in' => 'formData', - 'schema' => [ - 'title' => '子任务id，多个id以逗号分隔', - 'type' => 'string', - 'example' => '1,2', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Export pipeline', + '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' => '任务权重', - 'type' => 'integer', - 'format' => 'int32', - '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' => '依赖策略', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - '8', - ], - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ - 'name' => 'Coordinate', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '节点在工作流中的坐标', - 'type' => 'object', - 'properties' => [ - 'X' => [ - 'title' => 'X坐标', - 'type' => 'number', - 'format' => 'float', - 'example' => '100.0', - ], - 'Y' => [ - 'title' => 'Y坐标', - 'type' => 'number', - 'format' => 'float', - 'example' => '100.0', - ], - 'Width' => [ - 'title' => '宽度', - 'type' => 'number', - 'format' => 'float', - 'example' => '100.0', - ], - 'Height' => [ - 'title' => '高度', - 'type' => 'number', - 'format' => 'float', - 'example' => '50.0', - ], - ], - ], + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], ], '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' => '', - 'type' => 'string', - 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Not found: appName not found.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request, generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => '- The details of the application.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74', - ], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3402', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'AccessToken' => ['description' => 'The access token.', 'type' => 'string', 'example' => '2f4ddeab8e344ed68e0402cf9b8502ffv3', 'title' => ''], + 'Title' => ['description' => 'The title of the application.', 'type' => 'string', 'example' => '测试应用', 'title' => ''], + 'Creator' => ['description' => 'The creator of the application.', 'type' => 'string', 'example' => '18582193685027xx', 'title' => ''], + 'Updater' => ['description' => 'The last user to update the application.', 'type' => 'string', 'example' => '18582193685027xx', 'title' => ''], + 'Leader' => ['description' => 'The leader address.', 'type' => 'string', 'example' => 'http://28.***.***.3:80'."\n", 'title' => ''], + 'MaxJobs' => ['description' => 'The maximum number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'MaxConcurrency' => ['description' => 'The maximum concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'JobNum' => ['description' => 'The number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ExecutorNum' => ['description' => 'The number of executors.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'EnableLog' => ['description' => 'Indicates whether logging is enabled.'."\n" + ."\n" + .'- `true`: Enabled.'."\n" + ."\n" + .'- `false`: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'LabelRouteStrategy' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'AppType' => ['title' => 'Application type', 'description' => 'The application type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'CreateJob', - ], - 'UpdateJob' => [ - 'summary' => 'Updates the job information.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve a specified application', + 'summary' => 'Retrieves the details of a specified application.', + 'changeSet' => [ + ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => 'Response parameters changed'], ], - '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' => 'Retrieves the details of a specified calendar.', + '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' => '', - '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' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '74', - ], + 'name' => 'CalendarName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the calendar.', 'type' => 'string', 'required' => true, 'example' => 'workday', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test-job'."\n", - 'maxLength' => 200, - ], + 'name' => 'Year', + 'in' => 'query', + 'schema' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], ], - [ - 'name' => 'Description', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test'."\n", - 'maxLength' => 300, + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2C3E52FF-CBE9-5C0E-8252-37ACFF1F5EFF'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '- The data returned.', + 'type' => 'object', + 'properties' => [ + 'CalendarName' => ['description' => 'The name of the calendar.', 'type' => 'string', 'example' => 'workday', 'title' => ''], + 'Year' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'example' => '2030', 'title' => ''], + 'Months' => ['description' => 'A JSON string that represents an array of objects. Each object specifies the days for a particular month.', '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" + .']', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'RouteStrategy', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9', - 'minimum' => '1', - 'example' => '1', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - 'name' => 'Parameters', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test'."\n", - 'maxLength' => 2000, - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], - [ - 'name' => 'MaxConcurrency', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - 'name' => 'MaxAttempt', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'default' => '0', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], - [ - 'name' => 'AttemptInterval', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - 'default' => '30', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], + ], + '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' => 'Obtain calendar ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'GetCluster' => [ + 'summary' => 'Obtains the details of a cluster.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'JobHandler', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - '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任务，通过该字段配置脚本', - 'type' => 'string', - 'example' => 'echo "hello world"', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa'], ], - [ - 'name' => 'TimeType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - 'enum' => [ - '-1', - '1', - '3', - '5', - '100', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. The value is a unique identifier that Alibaba Cloud generates for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'xxljob-e0d018c6df8', 'title' => ''], + 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'xxl-job-test-1730427575152', 'title' => ''], + 'ClusterSpec' => ['description' => 'The cluster specification. Valid values:'."\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', 'title' => ''], + 'ProductType' => ['description' => 'The product edition.'."\n" + ."\n" + .'- 1: Developer Edition.'."\n" + ."\n" + .'- 2: Professional Edition.'."\n" + ."\n" + .'- 3: Enterprise Edition.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'EngineType' => ['description' => 'The engine type. Valid value: xxljob.', 'type' => 'string', 'example' => 'xxljob', 'title' => ''], + 'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '2.0.0', 'title' => ''], + 'Status' => ['description' => 'The cluster status.'."\n" + ."\n" + .'- 1: Being created.'."\n" + .'- 2: Running.'."\n" + .'- 3: Restarting.'."\n" + .'- 4: Being released.'."\n" + .'- 5: Creation failed.'."\n" + .'- 6: Stopped.'."\n" + .'- 99: Deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the cluster was created.', 'type' => 'string', 'example' => '2024-10-29 15:56:36', 'title' => ''], + 'EndTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2024-10-29 15:56:36', 'title' => ''], + 'IntranetDomain' => ['description' => 'The internal endpoint.', 'type' => 'string', 'example' => 'http://xxljob-xxxxxx.schedulerx.mse.aliyuncs.com', 'title' => ''], + 'InternetDomain' => ['description' => 'The public endpoint.'."\n" + .'> Currently not supported.', 'type' => 'string', 'example' => '暂无', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" + .'- PREPAY: subscription.'."\n" + .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'KubeConfig' => ['description' => 'The configuration of the Kubernetes server.', '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", 'title' => ''], + 'JobNum' => ['description' => 'The maximum number of jobs for the current specification.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'WorkerNum' => ['description' => 'The number of workers.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'VSwitches' => [ + 'description' => 'The vSwitch information of zones.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-k', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-8vbf1n216nshvfjdyff8a', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1fiz967u39lt8yuxcs0', 'title' => ''], + 'MaxJobNum' => ['description' => 'The maximum number of jobs for the current specification.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Spm' => ['description' => 'The peak number of scheduling operations per minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Zones' => [ + 'description' => 'The list of zones.', + 'type' => 'array', + 'items' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'VersionLifecycle' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MaxWorkflowNum' => ['title' => '', 'description' => 'The maximum number of workflows supported.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'WorkflowNum' => ['title' => '', 'description' => 'The current number of workflows.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'IpWhitelist' => ['title' => '', 'type' => 'string', 'example' => '192.168.1.0/24', 'description' => ''], + 'Tags' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'ClusterType' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], + 'Source' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], ], + 'example' => '', ], ], - [ - 'name' => 'TimeExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0 4 ? * Mon/1'."\n", - ], - ], - [ - 'name' => 'Calendar', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workday', - ], - ], - [ - 'name' => 'Priority', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '10', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - 'name' => 'StartTimeType', - 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间类型', - 'type' => 'string', - 'example' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - ], - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1716902187', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - 'name' => 'Timezone', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Asia/Beijing', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], - [ - 'name' => 'NoticeConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimeoutEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - 'Timeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '90', - 'default' => '7200', - ], - 'TimeoutKillEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - 'SuccessNotice' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'FailEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - 'FailLimitTimes' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'true', - 'default' => '1', - ], - 'MissWorkerEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'SendChannel' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'webhook,sms,mail,phone'."\n", - ], - 'EndEarlyEnable' => [ - 'title' => '提前结束报警开关', - 'type' => 'boolean', - 'default' => 'false', - ], - 'EndEarly' => [ - 'title' => '提前结束的阈值，单位秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - 'required' => false, - 'title' => '报警配置', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], - [ - 'name' => 'NoticeContacts', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'ContactType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '1', - ], - ], - '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' => 'Obtain Cluster Details', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-04T09:16:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-29T06:59:52.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCluster'], ], + ], + ], + 'GetDesigateInfo' => [ + 'summary' => 'Retrieves the designation information for a job.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ExecutorBlockStrategy', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - '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，多个以逗号分隔', - 'type' => 'string', - 'example' => '1,2', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'Weight', - 'in' => 'formData', - 'schema' => [ - 'title' => '任务权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'DependentStrategy', - 'in' => 'formData', - 'schema' => [ - 'title' => '依赖策略', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - '8', - ], - ], + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3808cf26-dde2-4286-8503-b0a2cd4065a7', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request, generated by Alibaba Cloud for troubleshooting.', 'type' => 'string', 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'DesignateType' => ['description' => 'The designation type. Valid values:'."\n" + ."\n" + .'- 1: Designates a specific worker.'."\n" + ."\n" + .'- 2: Designates a group of machines using a label.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Transferable' => ['description' => 'Indicates whether failover is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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' => 'UpdateJob', - ], - 'UpdateJobScript' => [ - 'summary' => '更新任务脚本内容', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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' => 'Obtain the information of the specified machine', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDesigateInfo'], + ], ], + ], + 'GetExecutorConfig' => [ + 'summary' => 'Retrieves the configuration for a specified Executor.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d', 'title' => ''], ], [ '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' => '', - ], - ], - [ - 'name' => 'VersionDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'init version', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '74', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', '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' => '', - 'type' => 'string', - 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589'], + 'Code' => ['description' => 'The status code returned for the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The configuration data for the Executor.', + 'type' => 'object', + 'properties' => [ + 'Config' => ['description' => 'The default global configuration for Data Integration tasks. This configuration specifies the default handling policies for different types of DDL messages. Example:'."\n" + .'`{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}`'."\n" + ."\n" + .'The DDL message types are as follows:'."\n" + ."\n" + .'- RENAMECOLUMN: `RENAME COLUMN`'."\n" + ."\n" + .'- DROPTABLE: `DROP TABLE`'."\n" + ."\n" + .'- CREATETABLE: `CREATE TABLE`'."\n" + ."\n" + .'- MODIFYCOLUMN: `MODIFY COLUMN`'."\n" + ."\n" + .'- TRUNCATETABLE: `TRUNCATE TABLE`'."\n" + ."\n" + .'- DROPCOLUMN: `DROP COLUMN`'."\n" + ."\n" + .'- ADDCOLUMN: `ADD COLUMN`'."\n" + ."\n" + .'- RENAMETABLE: `RENAME TABLE`'."\n" + ."\n" + .'When DataWorks receives a DDL message, it applies one of the following handling policies:'."\n" + ."\n" + .'- WARNING: Discards the message and logs a warning in the Real-time Synchronization Task log.'."\n" + ."\n" + .'- IGNORE: Discards the message without sending it to the Destination Data Source.'."\n" + ."\n" + .'- CRITICAL: Causes the Real-time Synchronization Task to fail.'."\n" + ."\n" + .'- NORMAL: Forwards the message to the Destination Data Source. Because handling of DDL messages can vary by Destination Data Source, DataWorks only forwards the message.', 'type' => 'string', 'example' => '[{"cluster":"c2c619b5129e0400fa3df263b249622aa","namespace":"default","service":"xxljob-http-demo1-svc"}]', 'title' => ''], + 'ExecutorType' => ['description' => 'The type of the Executor.', 'type' => 'string', 'example' => 'k8s_service', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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"}]', - ], - 'DeleteJobs' => [ - 'summary' => 'Deletes multiple jobs at a time.', - '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' => 'Obtain the configuration information of the specified executor ', + 'description' => '# Add the enhancement plugin'."\n" + ."\n" + .'Add the Enhancement Plugin to your `pom.xml` file to extend the Executor\'s capabilities.'."\n" + ."\n" + .'**Note**: Place this plugin **before** the `xxl-job-core` dependency in the `pom.xml` file.'."\n" + ."\n" + .'**For more information, see**: [Plugin Version Documentation](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetJobExecution' => [ + 'summary' => 'Returns the details of a Task Execution.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'JobExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the job execution.', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120', 'title' => ''], + ], + [ + 'name' => 'MseSessionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '91143E1D-E235-5BE0-9364-C2EE28FFB5A6', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'JobExecutionId' => ['description' => 'The ID of the job execution.', 'type' => 'string', 'example' => '1310630367761285120', 'title' => ''], + 'JobId' => ['description' => 'The ID of the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '74', 'title' => ''], + 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => '天猫-自动审单', 'title' => ''], + 'JobType' => ['description' => 'The type of the job.', 'type' => 'string', 'example' => 'xxljob', 'title' => ''], + 'Parameters' => ['description' => 'The parameters of the job.', 'type' => 'string', 'example' => '/home/avatar/system/services/biz/payment/crontab/monitorpayment.php', 'title' => ''], + 'ScheduleTime' => ['description' => 'The scheduled time for the job execution.', 'type' => 'string', 'example' => '2025-03-11 00:06:10', 'title' => ''], + 'DataTime' => ['description' => 'The data timestamp for the job instance.', 'type' => 'string', 'example' => '2025-03-11 00:06:10', 'title' => ''], + 'StartTime' => ['description' => 'The time when the job execution started.', 'type' => 'string', 'example' => '2025-03-11 00:06:10', 'title' => ''], + 'EndTime' => ['description' => 'The time when the job execution ended.', 'type' => 'string', 'example' => '2024-10-29 15:56:36', 'title' => ''], + 'Duration' => ['description' => 'The duration of the job execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Executor' => ['description' => 'Details of the executor that ran the job. The value is a JSON string.', 'type' => 'string', 'example' => '{\'Status\': \'NORMAL\', \'ActiveCount\': 4, \'UnavailableCount\': 0, \'ExpectedCount\': 4, \'RiskCount\': 0}', 'title' => ''], + 'Result' => ['description' => 'The result of the job execution. The value is a JSON string.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'Status' => ['description' => 'The job execution status. Valid values:'."\n" + ."\n" + .'- `0`: `UNKNOWN`'."\n" + ."\n" + .'- `1`: `WAITING`'."\n" + ."\n" + .'- `2`: `READY`'."\n" + ."\n" + .'- `3`: `RUNNING`'."\n" + ."\n" + .'- `4`: `SUCCESS`'."\n" + ."\n" + .'- `5`: `FAILED`', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'TimeType' => ['description' => 'The scheduling type of the job. Valid values:'."\n" + ."\n" + .'- `-1`: `none`'."\n" + ."\n" + .'- `1`: `cron`'."\n" + ."\n" + .'- `2`: `fixed_delay`'."\n" + ."\n" + .'- `3`: `fixed_rate`'."\n" + ."\n" + .'- `5`: `one_time`'."\n" + ."\n" + .'- `100`: `api`', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Attempt' => ['description' => 'The number of execution attempts.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'RouteStrategy' => ['description' => 'The routing strategy. Valid values:'."\n" + ."\n" + .'- `1`: `Round Robin`'."\n" + ."\n" + .'- `2`: `Random`'."\n" + ."\n" + .'- `3`: `First`'."\n" + ."\n" + .'- `4`: `Last`'."\n" + ."\n" + .'- `5`: `Least Frequently Used`'."\n" + ."\n" + .'- `6`: `Least Recently Used`'."\n" + ."\n" + .'- `7`: `Consistent Hashing`'."\n" + ."\n" + .'- `8`: `Shard Broadcasting`', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ServerIp' => ['description' => 'The IP address of the scheduling server.', 'type' => 'string', 'example' => '172.3.27.76', 'title' => ''], + 'TriggerType' => ['description' => 'Indicates how the job was triggered. Valid values:'."\n" + ."\n" + .'- `0`: `unknown`'."\n" + ."\n" + .'- `1`: `timer_schedule`'."\n" + ."\n" + .'- `2`: `rerun`'."\n" + ."\n" + .'- `3`: `api_run`'."\n" + ."\n" + .'- `4`: `user_retry`'."\n" + ."\n" + .'- `5`: `system_retry`'."\n" + ."\n" + .'- `6`: `manual`', 'type' => 'integer', 'format' => 'int32', 'example' => 'timer_schedule', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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' => 'DeleteJobs', - ], - 'OperateEnableJobs' => [ - 'summary' => 'Enables multiple jobs at a time.', - 'methods' => [ - 'post', + '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' => 'Obtain detailed information about task execution ', + 'changeSet' => [ + ['createdAt' => '2025-06-04T09:10:28.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetJobExecutionProgress' => [ + 'summary' => 'Gets the details of a sharding task execution.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The cluster 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' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'JobExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The job execution ID.', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4CC4132F-B798-5D6E-9F06-D44B33E417E9', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier for the request, generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '9B57FDD7-ABBE-5030-B348-86EB9943DB59', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'Parameter format error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '- The data returned by the request.', + 'type' => 'object', + 'properties' => [ + 'JobDescription' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => '测试任务', 'title' => ''], + 'TotalProgress' => [ + 'description' => 'The overall progress of the job.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of items in the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'Finished' => ['description' => 'The number of finished items in the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RootProgress' => [ + 'description' => 'The progress of the root task.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of items in the root task.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'Finished' => ['description' => 'The number of finished items in the root task.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'TaskProgress' => [ + 'description' => 'A list of progress details for each subtask.', + 'type' => 'array', + 'items' => [ + 'description' => 'The progress details of a subtask.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the subtask.', 'type' => 'string', 'example' => 'calendar_test_2', 'title' => ''], + 'Total' => ['description' => 'The total number of items in the subtask.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'Pulled' => ['description' => 'The number of pulled items.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Queue' => ['description' => 'The number of items in the subtask\'s queue.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Running' => ['description' => 'The number of running items.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ShardingProgress' => [ + 'description' => 'A list of progress details for each sharding task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The progress details of a sharding task.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'WorkerAddr' => ['description' => 'The address of the Worker.', 'type' => 'string', 'example' => 'http://192.168.***.9:9999/', 'title' => ''], + 'Status' => ['description' => 'The execution status of the sharding task. Valid values:'."\n" + ."\n" + .'- 0: UNKNOWN'."\n" + ."\n" + .'- 1: INIT'."\n" + ."\n" + .'- 2: PULLED'."\n" + ."\n" + .'- 3: RUNNING'."\n" + ."\n" + .'- 4: SUCCESS'."\n" + ."\n" + .'- 5: FAILED', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'StatusType' => [ + 'description' => 'Detailed information about the execution status.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Name' => ['description' => 'The name of the status.', 'type' => 'string', 'example' => 'TaskStatus.FAILED', 'title' => ''], + 'Tips' => [ + 'description' => 'Informational messages about the status.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Additional informational messages.', 'type' => 'string', 'example' => 'Task execution failed', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'JobExecutionId' => ['description' => 'The execution ID of the sharding task.', 'type' => 'string', 'example' => '1306189481388277762', 'title' => ''], + 'Result' => ['description' => 'The execution result of the sharding task.', 'type' => 'string', 'example' => '2,4,6,8,10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WorkerProgress' => [ + 'description' => 'A list of execution progress details for each Worker.', + 'type' => 'array', + 'items' => [ + 'description' => 'The execution progress on a specific Worker.', + 'type' => 'object', + 'properties' => [ + 'WorkerAddr' => ['description' => 'The address of the Worker.', 'type' => 'string', 'example' => '10.***.***.53:61941'."\n", 'title' => ''], + 'Total' => ['description' => 'The total number of items processed by this Worker.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Pulled' => ['description' => 'The number of items pulled by this Worker.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Queue' => ['description' => 'The number of items in this Worker\'s queue.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Running' => ['description' => 'The number of items this Worker is currently running.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Success' => ['description' => 'The number of items successfully processed by this Worker.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Failed' => ['description' => 'The number of items that failed on this Worker.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '1a0e97fb17244665327205402dbd6d', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'StartTime' => ['title' => 'Start Time', 'description' => 'The job start time, in Unix milliseconds.', 'type' => 'string', 'example' => '1758506761000'], + 'EndTime' => ['title' => 'End time ', 'description' => 'The job end time, in Unix milliseconds.', 'type' => 'string', 'example' => '1758594961000'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'OperateEnableJobs', - ], - 'OperateDisableJobs' => [ - 'summary' => 'Disables multiple jobs at a time.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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' => 'Obtain the details of job execution', + 'description' => '# Add the enhancement plugin'."\n" + ."\n" + .'Add the Enhancement Plugin to your `pom.xml` file to enhance the capabilities of the Executor.'."\n" + ."\n" + .'**Note**: Place this plugin **above** the `xxl-job-core` dependency in your pom.xml.'."\n" + ."\n" + .'**See also**: [Plugin Release Notes](https://help.aliyun.com/zh/schedulerx/schedulerx-xxljob/product-overview/plugin-version-description)', + 'changeSet' => [ + ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobExecutionProgress'], + ], ], + ], + 'GetJobExecutionThreadDump' => [ + 'summary' => 'Retrieves the thread dump for a specific job execution.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxl-job-executor-sample', 'title' => ''], ], [ - 'name' => 'JobIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'JobExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The job execution ID.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], + ], + [ + 'name' => 'ExecutorAddr', + 'in' => 'query', + 'schema' => ['description' => 'The executor address.', 'type' => 'string', 'required' => false, 'example' => 'http://192.168.0.215:9966/', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request. Use this ID for troubleshooting.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: appId is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '- The returned data object.', + 'type' => 'object', + 'properties' => [ + 'Dump' => ['description' => 'The thread dump.', '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', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'OperateDisableJobs', - ], - 'OperateRerunJob' => [ - 'summary' => 'Reprocesses the historical data of a job.', - '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' => 'Query the job execution stack', + 'description' => '# Add the enhancement plugin'."\n" + ."\n" + .'Add the Enhancement Plugin to your `pom.xml` file to extend the executor\'s capabilities.'."\n" + ."\n" + .'**Note**: Place this plugin **above** the `xxl-job-core` dependency.'."\n" + ."\n" + .'**For more information, see**: [Plugin versioning documentation](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' => 'Retrieves log entries.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '74', - ], + 'schema' => ['description' => 'The job execution ID.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1698458024000', - ], + 'schema' => ['description' => 'The start time. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721636220', 'title' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1698458024000', - ], + 'schema' => ['description' => 'The end time. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721636220', 'title' => ''], ], [ - 'name' => 'DataTime', + 'name' => 'Level', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The log level.', 'type' => 'string', - 'required' => true, - 'example' => '14:11:10', + 'example' => 'INFO', + 'enum' => ['INFO', 'ERROR', 'WARN', 'DEBUG'], + 'required' => false, + 'title' => '', ], ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword to search for.', 'type' => 'string', 'required' => false, 'example' => 'hello word', 'title' => ''], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['description' => 'The offset.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'LineNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of log entries to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to sort the results in descending order.'."\n" + ."\n" + .'- **true**: sorts the results in descending order.'."\n" + ."\n" + .'- **false**: sorts the results in ascending order.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'LogId', + 'in' => 'query', + 'schema' => ['description' => 'The log ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '344008', 'title' => ''], + ], + [ + 'name' => 'WorkerAddr', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => 'Executor address', 'description' => 'The worker address.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.100'], + ], + [ + 'name' => 'ScheduleTime', + 'in' => 'query', + 'schema' => ['title' => 'Schedule time', 'description' => 'The time when the job was scheduled. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '2023-10-01 12:00:00', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BCDF4006-C8A1-5F83-9368-588347D3EE84', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Data' => [ + 'description' => 'The log entries.', + 'type' => 'array', + 'items' => ['description' => 'The log information.', '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', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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' => 'OperateRerunJob', - ], - 'ListJobs' => [ - 'summary' => 'Queries a list of jobs.', - 'methods' => [ - 'get', - 'post', + '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' => 'Query logs', + 'changeSet' => [ + ['createdAt' => '2025-10-17T05:41:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLog'], + ], ], + ], + 'GetLogEvent' => [ + 'summary' => 'Query Events.', + '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' => 'The unique identifier for the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-684d02ee5a6', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => false, 'example' => 'xxl-job-executor-perf-test-241', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'EventType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => 'Event type', + 'description' => 'The type of event to retrieve.', 'type' => 'string', 'required' => false, - 'example' => '0', + 'example' => 'JOB', + 'default' => 'JOB', + 'enum' => ['JOB', 'WORKFLOW'], ], ], [ - 'name' => 'JobId', + 'name' => 'JobName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'JobName', + 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'job01', - ], + 'schema' => ['description' => 'The unique identifier for the job execution.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'WorkflowName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['title' => 'Pipeline name', 'description' => 'The name of the workflow.', 'type' => 'string', 'example' => '流程001', 'required' => false], ], [ - 'name' => 'JobHandler', + 'name' => 'WorkflowExecutionId', + 'in' => 'query', + 'schema' => ['title' => 'Pipeline execution ID', 'description' => 'The unique identifier for the workflow execution.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1450568762586578000'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the query\'s time range, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721268302000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the query\'s time range, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1721636220', 'title' => ''], + ], + [ + 'name' => 'Event', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The severity level for filtering events.', 'type' => 'string', + 'example' => 'INFO', + 'enum' => [], 'required' => false, - 'example' => 'jobDemoHandler', + 'title' => '', ], ], [ - 'name' => 'PageNum', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'A keyword to search for in log events.', 'type' => 'string', 'required' => false, 'example' => 'test_partition_tbl', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], + 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'WorkflowId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '工作流ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to retrieve.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the sort order of events.'."\n" + ."\n" + .'- **true**: Sorts events in descending order.'."\n" + ."\n" + .'- **false**: Sorts events in ascending order.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The HTTP status code. A value of `200` indicates a successful request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique, server-generated ID for the request. This ID is used for troubleshooting purposes.', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => '-', 'type' => 'object', @@ -5258,269 +3783,69 @@ 'description' => '-', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'job01', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'JobType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxljob', - ], - 'Status' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'JobHandler' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'jobDemoHandler', - ], - 'Priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TimeType' => [ - 'description' => '', - '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', - ], - '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' => '', - 'type' => 'string', - 'example' => '', - ], - 'NoticeConfig' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"failLimitTimes":1,"failEnable":true,"timeoutKillEnable":false,"missWorkerEnable":true,"timeoutEnable":true,"sendChannel":"","timeout":300,"successNotice":false}', - ], - 'NoticeContacts' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RouteStrategy' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-app', - ], - 'Timezone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'HangKong', - ], - 'LastExecuteEndTime' => [ - 'type' => 'string', - ], - 'LastExecuteStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CurrentExecuteStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'enum' => [ - '0', - '1', - '2', - '3', - ], - ], - 'ChildJobId' => [ - 'type' => 'string', - ], - 'Weight' => [ - 'title' => '任务权重', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NodeType' => [ - 'title' => '节点类型', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DependentStrategy' => [ - 'title' => '依赖检查策略', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Script' => [ - 'type' => 'string', - ], - 'WorkflowId' => [ - 'title' => '工作流ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ExecutorBlockStrategy' => [ - 'type' => 'string', - ], - 'StartTimeType' => [ - 'title' => '开始时间类型', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'EventType' => ['title' => 'Type of management event ', 'description' => 'The type of the event.', 'type' => 'string', 'example' => 'JOB'], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'portal-dev', 'title' => ''], + 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'JobExecutionId' => ['description' => 'The job execution ID.', 'type' => 'string', 'example' => '101', 'title' => ''], + 'WorkflowName' => ['title' => 'pipeline Name ', 'description' => 'The name of the workflow.', 'type' => 'string', 'example' => '工作流0001'], + 'WorkflowExecutionId' => ['title' => 'Workflow Execution Record ID ', 'description' => 'The workflow execution ID.', 'type' => 'string', 'example' => '1450568762586578000'], + 'Event' => ['description' => 'The severity level of the event.', 'type' => 'string', 'example' => 'info', 'title' => ''], + 'WorkerAddr' => ['description' => 'The address of the worker that runs the job.', 'type' => 'string', 'example' => '030225016025_9357_60125@127.0.0.1:51363', 'title' => ''], + 'Content' => ['description' => 'The log content.', 'type' => 'string', 'example' => 'hello word', 'title' => ''], + 'Time' => ['description' => 'The time when the log was recorded. The time is in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2024-10-31 16:43:51', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '65', - 'title' => '任务扩展属性配置信息', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'ListJobs', - ], - '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' => 'Query Management Event ', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLogEvent'], + ], ], + ], + 'GetPageLog' => [ + 'summary' => '', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5529,205 +3854,154 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'JobName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '74', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'job01', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'WorkerAddr', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '192.168.1.100', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'example' => '1777292662000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'example' => '1777292662000', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'hello word', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'description' => '', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100', 'description' => '', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '-', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'], + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'CalendarName is already existed', 'title' => ''], 'Data' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ 'Records' => [ - 'description' => '-', 'type' => 'array', 'items' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ - 'VersionDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'init version', - ], - 'ScriptContent' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-29 15:56:36', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1963096506470832', - ], + 'Time' => ['type' => 'string', 'description' => '', 'example' => '2024-10-31 16:43:51'."\n", 'title' => ''], + 'AppName' => ['type' => 'string', 'description' => '', 'example' => 'test-app', 'title' => ''], + 'JobName' => ['type' => 'string', 'description' => '', 'example' => 'test', 'title' => ''], + 'JobExecutionId' => ['type' => 'string', 'description' => '', 'example' => '101', 'title' => ''], + 'Log' => ['type' => 'string', 'description' => '', 'example' => '[2026-02-10 10:23:36]tStart writing to Recall Enginen', 'title' => ''], + 'WorkerAddr' => ['type' => 'string', 'description' => '', 'example' => '030225016025_9357_60125@127.0.0.1:51363', 'title' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'example' => 'zhangsan', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'NextToken' => [ 'description' => '', - 'type' => 'string', - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], - 'Total' => [ - 'description' => '', - 'type' => 'string', - 'example' => '21', + 'title' => '', + 'example' => '', ], + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '65', 'title' => ''], + 'PageNum' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '10', 'title' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '10', 'title' => ''], ], - ], - 'MaxResults' => [ 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], - ], - ], - '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"}]', + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], + ], + '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 \\"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' => 'Queries a specified machine.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetWorkflow' => [ + 'summary' => 'Retrieves the basic information for a specified workflow.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5739,144 +4013,118 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxl-job-executor-sample', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '74', - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => '-', 'type' => 'object', 'properties' => [ - 'DesignateType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Transferable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Name' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'myWorkflow', 'title' => ''], + 'Description' => ['description' => 'The workflow description.', 'type' => 'string', 'example' => 'my first workflow', 'title' => ''], + 'Status' => ['description' => 'The workflow status.'."\n" + ."\n" + .'- 0: disabled'."\n" + ."\n" + .'- 1: enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'MaxConcurrency' => ['description' => 'The maximum concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'TimeType' => ['description' => 'The schedule type.'."\n" + ."\n" + .'- -1: None'."\n" + ."\n" + .'- 1: cron'."\n" + ."\n" + .'- 100: API', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TimeExpression' => ['description' => 'The time expression. The value of this parameter depends on the schedule type.'."\n" + ."\n" + .'- **None**: No expression is required.'."\n" + ."\n" + .'- **cron**: A standard cron expression.'."\n" + ."\n" + .'- **API**: No expression is required.', 'type' => 'string', 'example' => '0 0 12 * * ?', 'title' => ''], + 'Timezone' => ['description' => 'The time zone.'."\n" + ."\n" + .'> If this parameter is omitted, the time zone of the server in the current region is used.', 'type' => 'string', 'example' => 'GMT+8', 'title' => ''], + 'Calendar' => ['description' => 'The custom calendar.', 'type' => 'string', 'example' => 'workday', 'title' => ''], + 'Creator' => ['description' => 'The user who created the workflow.', 'type' => 'string', 'example' => '18582193685027xx', 'title' => ''], + 'Updater' => ['description' => 'The user who last updated the workflow.', 'type' => 'string', 'example' => '18582193685027xx', 'title' => ''], + 'Xattrs' => ['description' => 'The extended attributes.'."\n" + ."\n" + .'> This parameter is not supported.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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 \\"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' => 'Obtain basic information about a pipeline ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'GetDesigateInfo', ], - 'GetJobExecution' => [ - 'summary' => '获取任务执行的详细信息', + 'GetWorkflowDAG' => [ + 'summary' => 'Gets the Directed Acyclic Graph (DAG) of a workflow.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5888,548 +4136,530 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmseWGXOHM', - ], + 'abilityTreeCode' => '260227', + 'abilityTreeNodes' => ['FEATUREmsePN2NBR'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], - ], - [ - 'name' => 'JobExecutionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'MseSessionId', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'], + 'Code' => ['description' => 'The Response Code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The Error Message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'JobExecutionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1310630367761285120', - ], - 'JobId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74', - ], - 'JobName' => [ - 'description' => '', - 'type' => 'string', + 'Nodes' => [ + 'description' => 'A list of Nodes in the Workflow DAG.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object representing a Node in the DAG.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The Job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Name' => ['description' => 'The Job name.', 'type' => 'string', 'example' => 'job1', 'title' => ''], + 'AppName' => ['description' => 'The Application Name.', 'type' => 'string', 'example' => 'oak-payment-async-job', 'title' => ''], + 'Status' => ['description' => 'The Job Status.'."\n" + ."\n" + .'- 0: Disabled'."\n" + ."\n" + .'- 1: Enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'JobType' => ['description' => 'The Job type.', 'type' => 'string', 'example' => 'script_shell', 'title' => ''], + 'Coordinate' => [ + 'description' => 'The coordinates of the Node.', + 'type' => 'object', + 'properties' => [ + 'X' => ['description' => 'The x-coordinate of the Node.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], + 'Y' => ['description' => 'The y-coordinate of the Node.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], + 'Width' => ['description' => 'Optional. The width of the Node.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'Height' => ['description' => 'Optional. The height of the Node.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DependentStrategy' => ['description' => 'The Dependency Strategy.', 'type' => 'integer', 'format' => 'int32', 'example' => 'all_success', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', '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', - ], - 'DataTime' => [ - 'description' => '', - 'type' => 'string', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-03-11T00:06:10Z', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-29 15:56:36', - ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Executor' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\'Status\': \'NORMAL\', \'ActiveCount\': 4, \'UnavailableCount\': 0, \'ExpectedCount\': 4, \'RiskCount\': 0}', - ], - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'TimeType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Attempt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-app', - ], - 'RouteStrategy' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServerIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '172.3.27.76', - ], - 'TriggerType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'timer_schedule', + 'Edges' => [ + 'description' => 'A list of Edges in the Workflow DAG.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object representing an Edge between two Nodes.', + 'type' => 'object', + 'properties' => [ + 'Source' => ['description' => 'The Job ID of the source Node.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Target' => ['description' => 'The Job ID of the target Node.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Retrieve pipeline DAG information', + '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"}]', ], - 'OperateStopJobExecution' => [ - 'summary' => 'Stops running instances.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetWorkflowDAGPreview' => [ + 'summary' => 'Gets the DAG for a previous workflow version.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The unique identifier for the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobExecutionId', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'required' => true, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The unique identifier for the workflow.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'TaskList', + 'name' => 'DagVersion', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '子任务ID', - 'type' => 'array', - 'items' => [ - 'title' => '子任务id', - 'type' => 'string', - 'example' => '[1,2,3]', - ], - ], + 'schema' => ['description' => 'The version of the workflow DAG.', 'type' => 'string', 'required' => true, 'example' => 'v1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'B8733786-C045-59F1-8D79-99A52863F62D'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The workflow nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'A job node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job1', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'settle-job', 'title' => ''], + 'Status' => ['description' => 'The job status. Valid values:'."\n" + ."\n" + .'- `0`: Disabled'."\n" + ."\n" + .'- `1`: Enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'JobType' => ['description' => 'The job type.', 'type' => 'string', 'example' => 'script_shell', 'title' => ''], + 'Coordinate' => [ + 'description' => 'The node coordinates.', + 'type' => 'object', + 'properties' => [ + 'X' => ['description' => 'The x-coordinate.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], + 'Y' => ['description' => 'The y-coordinate.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], + 'Width' => ['description' => 'The node width. This parameter is optional.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'Height' => ['description' => 'The node height. This parameter is optional.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DependentStrategy' => ['description' => 'The dependency strategy.', 'type' => 'integer', 'format' => 'int32', 'example' => 'all_success', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Edges' => [ + 'description' => 'The workflow edges.', + 'type' => 'array', + 'items' => [ + 'description' => 'A workflow edge.', + 'type' => 'object', + 'properties' => [ + 'Source' => ['description' => 'The ID of the source node.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Target' => ['description' => 'The ID of the target node.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve the DAG of a pipeline History version ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'OperateStopJobExecution', ], - 'OperateDesignateExecutors' => [ - 'summary' => 'Designates executors.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetWorkflowExecutionDAG' => [ + 'summary' => 'Retrieve the DAG information for a workflow instance.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'WorkflowExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The workflow execution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter format error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- `true`: The call succeeded.'."\n" + ."\n" + .'- `false`: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned for the request.', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'A list of nodes in the workflow DAG.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a node in the DAG.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID for the job execution (node).', 'type' => 'string', 'example' => '7491777526619542799', 'title' => ''], + 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job1', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'cua-xxl-job-executor', 'title' => ''], + 'Status' => ['description' => 'The execution status of the job. Valid values:'."\n" + ."\n" + .'- 0: Unknown'."\n" + ."\n" + .'- 1: Waiting'."\n" + ."\n" + .'- 2: Queued'."\n" + ."\n" + .'- 3: Running'."\n" + ."\n" + .'- 4: Succeeded'."\n" + ."\n" + .'- 5: Failed'."\n" + ."\n" + .'- 6: Killed'."\n" + ."\n" + .'- 7: Held'."\n" + ."\n" + .'- 8: Marked as successful'."\n" + ."\n" + .'- 9: Skipped', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'JobType' => ['description' => 'The job type.', 'type' => 'string', 'example' => 'script_shell', 'title' => ''], + 'Coordinate' => [ + 'description' => 'The coordinates of the node.', + 'type' => 'object', + 'properties' => [ + 'X' => ['description' => 'The x-coordinate of the node.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], + 'Y' => ['description' => 'The y-coordinate of the node.', 'type' => 'number', 'format' => 'float', 'example' => '50', 'title' => ''], + 'Width' => ['description' => 'The width of the node. This parameter is optional.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], + 'Height' => ['description' => 'The height of the node. This parameter is optional.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'JobId' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Edges' => [ + 'description' => 'A list of edges in the workflow DAG.', + 'type' => 'array', + 'items' => [ + 'description' => 'Defines a directed edge from the node identified by `Source` to the node identified by `Target`. If the value of `Source` is `0`, the edge originates from the root node.', + 'type' => 'object', + 'properties' => [ + 'Source' => ['description' => 'The ID of the source node.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Target' => ['description' => 'The ID of the target node.', 'type' => 'string', 'example' => '1001', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], + ], [ - 'name' => 'JobId', + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], + ], + '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' => 'Obtain the DAG information of a pipeline instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ImportCalendar' => [ + 'summary' => 'Imports a calendar.', + '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '74', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the calendar.', 'type' => 'string', 'required' => true, 'example' => 'workday'], ], [ - 'name' => 'Transferable', + 'name' => 'Year', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], ], [ - 'name' => 'DesignateType', + 'name' => 'Months', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'enum' => [ - '1', - '2', - ], - ], + 'schema' => ['description' => 'The days of each month, in JSON format.', '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]}]', 'title' => ''], ], [ - 'name' => 'AddressList', + 'name' => 'ClusterId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://192.168.1.5:9999/', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID generated for the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned by the call.', + 'type' => 'array', + 'items' => ['description' => 'A status message that indicates the result of the operation.', 'type' => 'string', 'example' => 'refresh calendar success', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Import a calendar', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCalendar'], + ], ], - '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' => 'OperateDesignateExecutors', ], - 'OperateRetryJobExecution' => [ - 'summary' => 'Reruns failed job instances.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ImportJobs' => [ + 'summary' => 'Imports jobs in bulk.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6441,310 +4671,229 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227436', - 'abilityTreeNodes' => [ - 'FEATUREmseP3AH6A', - ], + 'abilityTreeCode' => '227422', + 'abilityTreeNodes' => ['FEATUREmse7UN7CQ'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'], ], [ - 'name' => 'JobExecutionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'required' => true, - 'example' => '1310630367761285120', - ], + 'name' => 'Overwrite', + 'in' => 'formData', + 'schema' => ['description' => 'Determines whether to overwrite jobs if they already exist. The default is **true**.'."\n" + ."\n" + .'- **true**: Overwrites existing jobs.'."\n" + ."\n" + .'- **false**: Does not overwrite existing jobs.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'TaskList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The jobs to import, formatted as a JSON string.', '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" + .'}', 'title' => ''], ], [ - 'name' => 'TriggerChild', - 'in' => 'query', - 'schema' => [ - 'title' => '是否触发下游', - 'type' => 'boolean', - 'default' => 'true', - ], + 'name' => 'AutoCreateApp', + 'in' => 'formData', + 'schema' => ['description' => 'Determines whether to automatically create the Application if it does not exist.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '438737AC-760A-57D9-B646-B7EF79426243', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'A unique identifier generated by Alibaba Cloud for this request. You can use this ID for troubleshooting.', 'type' => 'string', 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Batch import job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportJobs'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"438737AC-760A-57D9-B646-B7EF79426243\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'OperateRetryJobExecution', ], - 'OperateExecuteJob' => [ - 'summary' => 'Runs a job once.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ImportWorkflows' => [ + 'summary' => 'Imports one or more workflows.', + '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' => '', - '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' => 'The ID of the target cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d'], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '74', - ], - ], - [ - 'name' => 'InstanceParameters', + 'name' => 'Overwrite', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'name=zhangsan', - ], + 'schema' => ['description' => 'Specifies whether to overwrite an existing workflow that has the same name. Default value: `true`.'."\n" + ."\n" + .'- `true`: The existing workflow is overwritten.'."\n" + ."\n" + .'- `false`: The existing workflow is not overwritten.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Worker', + 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'title' => '指定机器的workerAddr', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://192.168.1.5:9999/', - ], + 'schema' => ['description' => 'The definitions of the workflows to import. The content must be a valid JSON string.', '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"}]}]', 'title' => ''], ], [ - 'name' => 'Label', + 'name' => 'AutoCreateApp', 'in' => 'formData', - 'schema' => [ - 'title' => '指定机器的标签', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gray', - ], + 'schema' => ['description' => 'Specifies whether to automatically create the application if it does not exist.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6305893D-517D-5131-A767-644EDA81CEC3', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'JobExecutionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1310630367761285120', - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'A unique identifier for the API call, generated by Alibaba Cloud. Use this ID for troubleshooting.', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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' => 'OperateExecuteJob', - ], - 'GetJobExecutionProgress' => [ - 'summary' => 'Obtains the execution details of a job.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + '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' => 'Import pipeline', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ListAlarmEvent' => [ + 'summary' => 'Retrieves alert events.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6753,352 +4902,186 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobExecutionId', + 'name' => 'JobName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'required' => true, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'required' => false, 'example' => 'test-job', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range for querying events. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1690419316000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range for querying events. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731636011558', 'title' => ''], + ], + [ + 'name' => 'AlarmType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the alarm. Valid values:'."\n" + ."\n" + .'- **`schedulerx3_no_designate_machine_alarm`**: The Designated Machine is unavailable.'."\n" + ."\n" + .'- **`schedulerx3_all_busy_alarm`**: All available machines are busy.'."\n" + ."\n" + .'- **`schedulerx3_no_machine_alarm`**: No machines are available to run the job.'."\n" + ."\n" + .'- **`schedulerx3_timeout_alarm`**: The job timed out.'."\n" + ."\n" + .'- **`schedulerx3_fail_alarm`**: The job failed to run.'."\n" + ."\n" + .'- **`schedulerx3_job_success_notice`**: The job ran successfully.', 'type' => 'string', 'required' => false, 'example' => 'schedulerx3_fail_alarm', 'title' => ''], + ], + [ + 'name' => 'AlarmChannel', + 'in' => 'query', + 'schema' => ['description' => 'The channel for sending alarm notifications. Valid values:'."\n" + ."\n" + .'- `sms`: SMS'."\n" + ."\n" + .'- `mail`: Email'."\n" + ."\n" + .'- `phone`: Phone call'."\n" + ."\n" + .'- `webhook`: Webhook', 'type' => 'string', 'required' => false, 'example' => 'webhook', 'title' => ''], + ], + [ + 'name' => 'AlarmStatus', + 'in' => 'query', + 'schema' => ['description' => 'The delivery status of the alarm notification. Valid values:'."\n" + ."\n" + .'- `true`: The notification delivery succeeded.'."\n" + ."\n" + .'- `false`: The notification delivery failed.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'string', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => 'Set to true to return results in descending order.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9B57FDD7-ABBE-5030-B348-86EB9943DB59', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter format error', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. This unique identifier is generated by Alibaba Cloud for each request and can be used for troubleshooting.', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => 'The response 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' => [ - '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.1.9:9999/', - ], - 'Status' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1306189481388277762', - ], - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2,4,6,8,10', - ], - ], - ], - ], - 'WorkerProgress' => [ - 'description' => '', + 'Records' => [ + 'description' => 'The result set.', 'type' => 'array', 'items' => [ - 'description' => '-', + 'description' => 'An array of alarm events.', 'type' => 'object', 'properties' => [ - 'WorkerAddr' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.116.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' => '', - 'type' => 'string', - 'example' => '1a0e97fb17244665327205402dbd6d', - ], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'test-job', 'title' => ''], + 'AlarmType' => ['description' => 'The alarm type.', 'type' => 'string', 'example' => 'schedulerx3_fail_alarm', 'title' => ''], + 'AlarmChannel' => ['description' => 'The alarm channel.', 'type' => 'string', 'example' => 'webhook', 'title' => ''], + 'AlarmContacts' => ['description' => 'The alarm contacts.', 'type' => 'string', 'example' => 'zhangsan', 'title' => ''], + 'AlarmStatus' => ['description' => 'The alarm status.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'AlarmMessage' => ['description' => 'The alarm message.', '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', 'title' => ''], + 'Time' => ['description' => 'The time the event occurred, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2024-10-31 16:43:51'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'StartTime' => [ - 'title' => '开始时间', - 'type' => 'string', - 'example' => '1758506761000', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'type' => 'string', - 'example' => '1758594961000', - ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '64', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve alert events', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlarmEvent'], + ], ], - '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' => 'GetJobExecutionProgress', ], - 'GetJobExecutionThreadDump' => [ - 'summary' => '查询任务的线程堆栈', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAppNames' => [ + 'summary' => 'Returns a list of application names.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7107,144 +5090,97 @@ '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The cluster 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' => '', - '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' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID. Use this ID for troubleshooting.', 'type' => 'string', 'example' => '3881C59F-59F1-5B2E-8110-7D689CA9B207', 'title' => ''], + 'Success' => ['description' => 'Indicates if the request succeeded.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], + 'description' => '.', + 'type' => 'array', + 'items' => [ + 'description' => '.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique identifier.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'Title' => ['description' => 'The application title.', 'type' => 'string', 'example' => '测试应用', 'title' => ''], + 'AppGroupId' => ['description' => 'The ID of the application group.', 'type' => 'string', 'example' => 'test-app'."\n", 'title' => ''], + 'AppType' => ['title' => 'Application type ', 'description' => 'The app type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'WorkerRegistry' => ['title' => 'Manually registered executor type ', 'description' => 'The registry type for manually registered workers.', 'type' => 'string', 'example' => 'k8s_service'], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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"}]', - ], - 'ListJobExecutions' => [ - 'summary' => 'Obtains a list of job instances.', - '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' => 'Obtain a list of application names ', + 'changeSet' => [ + ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppNames'], + ], ], + ], + 'ListApps' => [ + 'summary' => 'Get the list of applications.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7253,379 +5189,140 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], - ], - [ - 'name' => 'WorkflowExecutionId', - 'in' => 'query', - 'schema' => [ - 'title' => '工作流实例ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], - ], - [ - 'name' => 'JobName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-job', - ], - ], - [ - 'name' => 'JobExecutionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'required' => false, - 'example' => '1310630367761285120', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-12 20:50:55', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2024-11-12 20:50:56', - ], + 'schema' => ['description' => 'The title.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '20', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1', - ], - 'Message' => [ - 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Parameter error: content is null.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- true: the call was successful.'."\n" + .'- false: the call failed.', 'type' => 'boolean', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ 'Records' => [ - 'description' => '-', 'type' => 'array', 'items' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ - 'JobExecutionId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1827811800526000', - ], - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'TimeType' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServerIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '28.0.168.46', - ], - 'TriggerType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalTokens' => [ - 'title' => 'AI任务消耗的tokens', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'WorkflowName' => [ - 'title' => '工作流名称', - 'type' => 'string', - 'example' => 'myWorkflow', - ], - 'WorkflowExecutionId' => [ - 'title' => '工作流实例ID', - 'type' => 'string', - 'example' => '100', - ], - 'JobId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74', - ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'WorkflowId' => [ - 'title' => '工作流ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'AccessToken' => ['description' => 'The AccessToken.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Title' => ['description' => 'The title.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Creator' => ['description' => 'The creator.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Updater' => ['description' => 'The updater.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Leader' => ['description' => 'The leader address.', 'type' => 'string', 'title' => '', 'example' => ''], + 'MaxJobs' => ['title' => '', 'description' => 'The maximum number of jobs.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'example' => ''], + 'MaxConcurrency' => ['description' => 'The maximum concurrency.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'JobNum' => ['description' => 'The number of jobs.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'ExecutorNum' => ['description' => 'The number of executors.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => ''], + 'EnableLog' => ['description' => 'Indicates whether logging is enabled.'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false: disabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'LabelRouteStrategy' => ['title' => '', 'description' => 'The label route strategy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AppType' => ['title' => '', 'description' => 'The application type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'WorkerType' => ['title' => '', 'description' => 'The worker type.', 'type' => 'string', 'example' => 'openclaw'], + 'WorkflowNum' => ['title' => '', 'description' => 'The current number of workflows.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '0'], + 'WorkerRegistry' => ['title' => '', 'description' => 'The manual executor registration type.', 'type' => 'string', 'deprecated' => false, 'example' => ''], + 'WorkerId' => ['title' => '', 'description' => 'The worker group ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], - 'title' => '任务实例', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'title' => '任务实例列表', - ], - 'Total' => [ 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'title' => '', + 'example' => '', ], + 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get the list of applications', + 'changeSet' => [ + ['createdAt' => '2025-12-25T03:50:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-23T06:05:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => 'Response parameters changed'], ], - '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' => 'ListJobExecutions', - ], - 'ListK8sResource' => [ - 'summary' => '获取k8s资源列表', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApps'], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Records\\": [\\n {\\n \\"Id\\": 0,\\n \\"AppName\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"Updater\\": \\"\\",\\n \\"Leader\\": \\"\\",\\n \\"MaxJobs\\": 0,\\n \\"MaxConcurrency\\": 0,\\n \\"JobNum\\": 0,\\n \\"ExecutorNum\\": 0,\\n \\"EnableLog\\": false,\\n \\"LabelRouteStrategy\\": 1,\\n \\"AppType\\": 1,\\n \\"WorkerType\\": \\"openclaw\\",\\n \\"WorkflowNum\\": 3,\\n \\"WorkerRegistry\\": \\"\\",\\n \\"WorkerId\\": 1\\n }\\n ],\\n \\"Total\\": 10,\\n \\"PageNumber\\": 0,\\n \\"PageSize\\": 0\\n }\\n}","type":"json"}]', + ], + 'ListCalendarNames' => [ + 'summary' => 'Lists all Calendar names.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7634,69 +5331,23 @@ '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' => '', + 'description' => 'The Cluster ID.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', - ], - ], - [ - 'name' => 'K8sClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cadb451ed7af04b0297f4be396a2196fc', - ], - ], - [ - 'name' => 'K8sNamespace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-aa1a18236n90rqhuhhnhh', + 'title' => '', ], ], ], @@ -7704,100 +5355,60 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => '-', 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'ResourceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'q_ecs_enterprise_spot_c', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxljob-01632622cda2f', - ], - ], - ], + 'items' => ['description' => 'The name of a Calendar.', 'type' => 'string', 'example' => 'workday', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Obtain a list of calendar names', + '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"}]', ], - 'GetLogEvent' => [ - 'summary' => '查询事件', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListCalendars' => [ + 'summary' => 'Retrieves a list of calendars.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7809,521 +5420,436 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-684d02ee5a6', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'title' => '', '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' => 'The name of the calendar.', 'type' => 'string', 'required' => false, 'example' => 'workday', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'Year', 'in' => 'query', - 'schema' => [ - 'title' => '事件类型', - 'type' => 'string', - 'required' => false, - 'example' => 'JOB', - 'default' => 'JOB', - 'enum' => [ - 'JOB', - 'WORKFLOW', - ], - ], + 'schema' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2024', 'title' => ''], ], [ - 'name' => 'JobName', + 'name' => 'FetchCalendarDetail', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Specifies whether to return calendar details. The default value is `false`.'."\n" + ."\n" + .'- `false`: Does not return the detailed list of days for each month. Only basic information is returned.'."\n" + ."\n" + .'- `true`: Returns the detailed list of days for each month.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'JobExecutionId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '101', - ], + 'schema' => ['description' => 'The maximum number of entries returned per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'example' => '10', 'title' => ''], ], [ - 'name' => 'WorkflowName', + 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => 'The token to retrieve the next page of results. Set this parameter to the `NextToken` value from the previous response. Omit this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '工作流名称', - 'type' => 'string', - 'example' => '流程001', + 'title' => 'Schema of Response', + 'description' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '- The returned data.', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => 'A list of calendars.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a calendar.', + 'type' => 'object', + 'properties' => [ + 'CalendarName' => ['description' => 'The name of the calendar.', 'type' => 'string', 'example' => 'workday', 'title' => ''], + 'Year' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'example' => '2025', 'title' => ''], + 'Months' => ['description' => 'A JSON string that represents an array of months and their corresponding days.', '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" + .']', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NextToken' => ['description' => 'The token for the next page of results. If this parameter is not returned, all results have been retrieved.', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], + ], [ - 'name' => 'WorkflowExecutionId', - 'in' => 'query', - 'schema' => [ - 'title' => '工作流执行ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1450568762586578000', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1721268302000', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Retrieve Calendar List', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ListClusters' => [ + 'summary' => 'Queries a list of instances.', + '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' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'Event', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INFO', - 'enum' => [], - ], + 'schema' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Value' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'test_partition_tbl', + 'maxItems' => 21, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '20', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'example' => 'cluster-test', 'title' => ''], ], [ - 'name' => 'Reverse', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'true', - ], + 'schema' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['title' => '', 'description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'required' => true, 'example' => 'Parameter error: content is null.'], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ 'Records' => [ - 'description' => '-', 'type' => 'array', 'items' => [ - 'description' => '-', 'type' => 'object', 'properties' => [ - 'EventType' => [ - 'title' => '事件类型', - 'type' => 'string', - 'example' => 'JOB', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'portal-dev', - ], - 'JobName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'JobExecutionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '101', - ], - 'WorkflowName' => [ - 'title' => '工作流名称', - 'type' => 'string', - 'example' => '工作流0001', - ], - 'WorkflowExecutionId' => [ - 'title' => '工作流执行记录ID', - 'type' => 'string', - 'example' => '1450568762586578000', - ], - 'Event' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '2024-10-31 16:43:51', + 'ClusterId' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'example' => 'xxljob-c20f7ec9a78'], + 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'xxl-job-test-1730427510169', 'title' => ''], + 'ClusterSpec' => ['title' => '', 'description' => 'The instance specifications.', 'type' => 'string', 'example' => 'scx.small.x2'], + 'ProductType' => ['title' => '', 'description' => 'The product edition. Valid values:'."\n" + .'- 1: Developer Edition.'."\n" + .'- 2: Professional Edition.'."\n" + .'- 3: Enterprise Edition.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'EngineType' => ['title' => '', 'description' => 'The engine type.', 'type' => 'string', 'example' => 'xxljob'], + 'EngineVersion' => ['title' => '', 'description' => 'The DPI engine version.', 'type' => 'string', 'example' => '2.0.0'], + 'Status' => ['title' => '', 'description' => 'The cluster status. Valid values:'."\n" + ."\n" + .'- 1: Creating.'."\n" + .'- 2: Running.'."\n" + .'- 3: Restarting.'."\n" + .'- 4: Deleting.'."\n" + .'- 5: Creation failed.'."\n" + .'- 6: Stopped.'."\n" + .'- 99: Deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-29 15:56:36', 'title' => ''], + 'EndTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2024-10-29 15:56:36', 'title' => ''], + 'IntranetDomain' => ['title' => '', 'description' => 'The internal domain name.', 'type' => 'string', 'example' => 'http://xxljob-b9e19e46c4e.schedulerx.mse.aliyuncs.com'], + 'InternetDomain' => ['title' => '', 'description' => 'The public domain name.'."\n" + .'> Not supported currently.', 'type' => 'string', 'example' => '暂无'], + 'ChargeType' => ['description' => 'The billing method. Valid values:'."\n" + .'- PREPAY: subscription.'."\n" + .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1fxort6ag5h9752i305', 'title' => ''], + 'VSwitches' => [ + 'description' => 'The zone and vSwitch information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result set.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-8vbl54xzux86usy61r5zm', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'SpInstanceId' => ['description' => 'The order asset instance ID.', 'type' => 'string', 'example' => 'mse_schedulerxpost_public_cn-htq402sak02', 'title' => ''], + 'VersionLifecycle' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Tags' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'ClusterType' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], + 'Source' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', + 'title' => '', + 'example' => '', ], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Query instance list', + 'changeSet' => [ + ['createdAt' => '2025-07-04T09:16:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-04-29T06:59:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => 'Response parameters changed'], ], - '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"}]', - ], - 'ImportJobs' => [ - 'summary' => 'Imports jobs at a time.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusters'], + ], ], + ], + 'ListContacts' => [ + 'summary' => '', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], - ], - [ - 'name' => 'Overwrite', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => '页码，从 1 开始，默认 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - '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' => '', 'type' => 'string', 'description' => '', 'required' => false, 'example' => 'Tom'], ], [ - 'name' => 'AutoCreateApp', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页条数，默认 20，最大 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'Success' => [ + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => '联系人列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['description' => '联系人 ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'job-85d64bff-50b5-4d02-aa3f-19956b17449d', 'title' => ''], + 'ContactName' => ['description' => '联系人名称', 'type' => 'string', 'example' => 'Tom', 'title' => ''], + 'Type' => ['description' => '渠道大类（IM/WEBHOOK/SMS/MAIL）', 'type' => 'string', 'example' => 'IM', 'title' => ''], + 'Config' => ['description' => '渠道配置 JSON（clientSecret 已脱敏为 ***）', 'type' => 'string', 'example' => '{"channels":[{"channelType":"dingtalk","clientId":"xxx","clientSecret":"xxx","targetType":"group","targetId":"xxx","robotCode":"xxx"}]}', 'title' => ''], + 'Enabled' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '1783065190000', 'title' => ''], + 'GmtModified' => ['description' => '最后修改时间', 'type' => 'string', 'example' => '1783065190000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], + 'PageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%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' => 'No permission to perform this operation: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + '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' => 'ImportJobs', + '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' => 'Obtains a list of all regions.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDatasources' => [ + 'summary' => 'Retrieve the data source list ', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8332,117 +5858,133 @@ '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' => 'Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Job Name.', 'type' => 'string', 'required' => false, 'example' => '修正券统计数据', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'Grafana dashboard type, including: dash-db: Dashboard; dash-folder: Folder (which can contain dashboards).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'REDIS', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'Maximum data volume to read in this request. Default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'Indicates the current read position returned by the call. An empty value means all data has been read. This parameter is not required for the first query.', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'Schema of Response ', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Regions' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - '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' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'RequestId' => ['description' => 'ID of the request ', 'title' => 'ID of the request ', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'], + 'Code' => ['description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded.'."\n" + .'- **true**: The invocation succeeded.'."\n" + .'- **false**: Failed to invoke.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'Returned data. ', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => '- ', + 'type' => 'array', + 'items' => [ + 'description' => '- ', + 'type' => 'object', + 'properties' => [ + 'DatasourceId' => ['description' => 'DataSource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '145', 'title' => ''], + 'Name' => ['description' => 'Job name.', 'type' => 'string', 'example' => 'job01', 'title' => ''], + 'Description' => ['description' => 'Job description.', 'type' => 'string', 'example' => 'my first workflow', 'title' => ''], + 'ConnectionParams' => ['description' => 'Data source connection parameters.', 'type' => 'string', 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}', 'title' => ''], + 'Updater' => ['description' => 'Updater.', 'type' => 'string', 'example' => '1827811800555555', 'title' => ''], + 'Type' => ['description' => 'Specific pronunciation rule Type. Options:'."\n" + ."\n" + .'- replacement: A rule that directly replaces Word with Pronunciation. ', 'type' => 'integer', 'format' => 'int32', 'example' => 'target', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Total' => ['description' => 'Total number of records. ', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageNumber' => ['description' => 'Page number. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxResults' => ['description' => 'Maximum Data Volume to read in this request. Default Value is 10. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NextToken' => ['description' => 'When the data matching the query conditions has not been fully read, the server returns a nextToken. You can use this nextToken to continue reading subsequent data. This parameter is not required for the first query. ', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'ListRegions', - ], - 'ListRegionZone' => [ - 'summary' => 'Obtains a list of zones.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List data sources', + '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"}]', + 'translator' => 'machine', + ], + 'ListExecutorGroup' => [ + 'summary' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8454,124 +5996,155 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '231656', - 'abilityTreeNodes' => [ - 'FEATUREmse8UT78G', + 'abilityTreeNodes' => ['FEATUREmse09FNQO'], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'group1', 'title' => ''], + ], + [ + 'name' => 'WorkerType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'openclaw', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'JSONResult', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'Code' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => '', 'example' => '200'], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'], + 'Message' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'Parameter check error'."\n"], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], 'Data' => [ - 'title' => '返回数据', - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'title' => 'zone id', - 'description' => 'zone id', - 'type' => 'string', - 'example' => 'cn-beijing-j', - ], - 'LocalName' => [ - 'title' => '本地名', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WorkerId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '12', 'title' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'example' => 'job01', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'example' => 'my first workflow', 'title' => ''], + 'WorkerType' => ['type' => 'string', 'description' => '', 'example' => 'k8s_service', 'title' => ''], + 'CiteList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['type' => 'string', 'description' => '', 'example' => 'Tornado', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'example' => 'group1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Network' => ['type' => 'string', 'description' => '', 'example' => 'public', 'title' => ''], + 'AuthType' => ['type' => 'string', 'description' => '', 'example' => 'api_key', 'title' => ''], + 'ApiKey' => ['type' => 'string', 'description' => '', 'example' => 'f/HElmWgOgmb0mlbRRkNuQ==', 'title' => ''], + 'Protocol' => ['type' => 'string', 'description' => '', 'example' => 'openai', 'title' => ''], + 'Workers' => ['type' => 'string', 'description' => '', 'example' => '[{"address":"http://47.111.188.191:18789"}]', 'title' => ''], + 'ResolvedWorkers' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IntegrationType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CmsWorkspaceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AutoScale' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'XAttrs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CurrentJobs' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'MaxJobs' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'E', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '10', 'title' => ''], + 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '1', 'title' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '10', 'title' => ''], ], - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorCode' => [ - 'title' => '错误码', - 'description' => '', - 'type' => 'string', - 'example' => 'IllegalRequest', - ], - 'Success' => [ - 'title' => '是否成功(前端要使用)', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => '错误消息', - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'RequestId' => [ - 'title' => '请求唯一标识', 'description' => '', - 'type' => 'string', - 'example' => '438737AC-760A-57D9-B646-B7EF79426243', + 'title' => '', + 'example' => '', ], + 'MaxResults' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '10', 'title' => ''], + 'NextToken' => ['type' => 'string', 'description' => '', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %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' => 'ListRegionZone', + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], + ], + '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\\": \\"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\\": false,\\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' => 'Obtains a list of calendar names.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListExecutors' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8583,22 +6156,29 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227444', - 'abilityTreeNodes' => [ - 'FEATUREmse8UT78G', - ], + 'abilityTreeCode' => '227430', + 'abilityTreeNodes' => ['FEATUREmseWGXOHM'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74', 'title' => ''], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'gray', 'title' => ''], ], ], 'responses' => [ @@ -8608,86 +6188,76 @@ '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' => '', - 'type' => 'string', - 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. Use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => 'A list of executors that match the filter criteria.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'workday', + 'description' => 'The details of an executor.', + 'type' => 'object', + 'properties' => [ + 'Address' => ['description' => 'The machine address.', 'type' => 'string', 'example' => 'http://192.168.1.10:9999/', 'title' => ''], + 'Ip' => ['description' => 'The IP address of the machine.', 'type' => 'string', 'example' => '192.168.1.10', 'title' => ''], + 'Port' => ['description' => 'The port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '9999', 'title' => ''], + 'Label' => ['description' => 'The label.', 'type' => 'string', 'example' => 'gray', 'title' => ''], + 'Version' => ['description' => 'The version number.', 'type' => 'string', 'example' => '2.0.2', 'title' => ''], + 'Online' => ['description' => 'Indicates whether the client is online.', 'type' => 'boolean', 'default' => 'true', 'example' => 'true', 'title' => ''], + 'IsDesignated' => ['description' => 'Indicates whether the executor is designated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Weight' => ['title' => 'Job weight ', 'description' => 'The task weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Executor List ', + 'summary' => 'Lists executors.', + 'changeSet' => [ + ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => 'Response parameters changed'], ], - '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' => 'ListCalendarNames', - ], - 'ListScheduleEvent' => [ - 'summary' => 'Queries scheduling events.', - 'methods' => [ - 'get', - ], - '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' => 'Returns a list of task instances.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8696,613 +6266,639 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The cluster 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' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobName', + 'name' => 'WorkflowExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-job', - ], + 'schema' => ['title' => 'Pipeline instance ID ', 'description' => 'The workflow execution ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'required' => false], ], [ - 'name' => 'JobExecutionId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'required' => false, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74', 'title' => ''], ], [ - 'name' => 'WorkflowName', + 'name' => 'JobName', 'in' => 'query', - 'schema' => [ - 'title' => '工作流名称', - 'type' => 'string', - 'example' => '流程001', - ], + 'schema' => ['description' => 'The job name.', 'type' => 'string', 'required' => false, 'example' => 'test-job', 'title' => ''], ], [ - 'name' => 'WorkflowExecutionId', + 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'title' => '工作流执行ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1450568762586578000', - ], + 'schema' => ['description' => 'The job execution ID.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The job execution status. Valid values:'."\n" + ."\n" + .'- 0: **UNKNOWN**.'."\n" + ."\n" + .'- 1: **WAITING**.'."\n" + ."\n" + .'- 2: **READY**.'."\n" + ."\n" + .'- 3: **RUNNING**.'."\n" + ."\n" + .'- 4: **SUCCESS**.'."\n" + ."\n" + .'- 5: **FAILED**.'."\n" + ."\n" + .'- 6: **PAUSED**.'."\n" + ."\n" + .'- 7: **SUBMITTED**.'."\n" + ."\n" + .'- 8: **REJECTED**.'."\n" + ."\n" + .'- 9: **ACCEPTED**.'."\n" + ."\n" + .'- 10: **PARTIAL\\_FAILED**.'."\n" + ."\n" + .'- 11: **SKIPPED**.'."\n" + ."\n" + .'- 12: **REMOVED**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1581317873000', - ], + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-11-12 20:50:55', 'required' => false, 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1728872796295', - ], + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-11-12 20:50:56', 'required' => false, 'title' => ''], ], [ - 'name' => 'Event', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INFO', - ], + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EventType', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '事件类型', - 'type' => 'string', - 'required' => false, - 'example' => 'JOB | WORKFLOW', - 'default' => 'JOB', + 'title' => 'Schema of Response', + 'description' => 'Response schema.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique identifier for the request. Alibaba Cloud generates this ID to help troubleshoot issues.', 'type' => 'string', 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1'], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Parameter error: content is null.'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => 'A list of job instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'A job instance.', + 'type' => 'object', + 'properties' => [ + 'JobExecutionId' => ['description' => 'The job execution ID.', 'type' => 'string', 'example' => '1310630367761285120', 'title' => ''], + 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'test-job', 'title' => ''], + 'JobType' => ['description' => 'The type of the job.', 'type' => 'string', 'example' => 'xxljob', 'title' => ''], + 'Parameters' => ['description' => 'The parameters of the job.', 'type' => 'string', 'example' => 'name=zhangsan', 'title' => ''], + 'ScheduleTime' => ['description' => 'The time when the job was scheduled.', 'type' => 'string', 'example' => '2024-11-12 14:52:42', 'title' => ''], + 'DataTime' => ['description' => 'The data timestamp for the job execution.', 'type' => 'string', 'example' => '2024-11-12 14:52:42', 'title' => ''], + 'EndTime' => ['description' => 'The time when the job execution ended.', 'type' => 'string', 'example' => '2024-11-12 14:52:42', 'title' => ''], + 'Executor' => ['description' => 'The ID of the executor.', 'type' => 'string', 'example' => '1827811800526000', 'title' => ''], + 'Result' => ['description' => 'The execution result.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Status' => ['description' => 'The job execution status. Valid values:'."\n" + ."\n" + .'- 0: UNKNOWN'."\n" + ."\n" + .'- 1: WAITING'."\n" + ."\n" + .'- 2: READY'."\n" + ."\n" + .'- 3: RUNNING'."\n" + ."\n" + .'- 4: SUCCESS'."\n" + ."\n" + .'- 5: FAILED'."\n" + ."\n" + .'- 6: PAUSED'."\n" + ."\n" + .'- 7: SUBMITTED'."\n" + ."\n" + .'- 8: REJECTED'."\n" + ."\n" + .'- 9: ACCEPTED'."\n" + ."\n" + .'- 10: PARTIAL\\_FAILED'."\n" + ."\n" + .'- 11: SKIPPED'."\n" + ."\n" + .'- 12: REMOVED', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'TimeType' => ['description' => 'The scheduling type. Valid values:'."\n" + ."\n" + .'- -1: none<br>'."\n" + ."\n" + .'- 1: cron<br>'."\n" + ."\n" + .'- 3: fix\\_rate<br>'."\n" + ."\n" + .'- 5: one\\_time<br>'."\n" + ."\n" + .'- 100: api', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Attempt' => ['description' => 'The attempt number for this execution. `1` indicates the initial run.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WorkAddr' => ['description' => 'The address of the worker that executed the job instance.', 'type' => 'string', 'example' => 'http://192.168.1.9:9999/', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'RouteStrategy' => ['description' => 'The strategy for routing the job to a worker. Valid values:'."\n" + ."\n" + .'- 1: Round-robin'."\n" + ."\n" + .'- 2: Random'."\n" + ."\n" + .'- 3: First'."\n" + ."\n" + .'- 4: Last'."\n" + ."\n" + .'- 5: Least Frequently Used'."\n" + ."\n" + .'- 6: Least Recently Used'."\n" + ."\n" + .'- 7: Consistent Hashing'."\n" + ."\n" + .'- 8: Sharded Broadcasting', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ServerIp' => ['description' => 'The IP address of the scheduler node.', 'type' => 'string', 'example' => '28.0.168.46', 'title' => ''], + 'TriggerType' => ['description' => 'The method that triggered the job. Valid values:'."\n" + ."\n" + .'- 0: unknown'."\n" + ."\n" + .'- 1: schedule'."\n" + ."\n" + .'- 2: rerun'."\n" + ."\n" + .'- 3: api'."\n" + ."\n" + .'- 4: user\\_retry'."\n" + ."\n" + .'- 5: system\\_retry'."\n" + ."\n" + .'- 6: manual', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalTokens' => ['title' => 'The number of tokens consumed by the AI job. ', 'description' => 'The total number of tokens consumed by the job execution.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], + 'WorkflowName' => ['title' => 'Pipeline name. ', 'description' => 'The name of the parent workflow, if applicable.', 'type' => 'string', 'example' => 'myWorkflow'], + 'WorkflowExecutionId' => ['title' => 'Pipeline instance ID. ', 'description' => 'The ID of the parent workflow instance, if applicable.', 'type' => 'string', 'example' => '100'], + 'JobId' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '74', 'title' => ''], + 'Duration' => ['description' => 'The duration of the job execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'WorkflowId' => ['title' => 'Pipeline ID', 'description' => 'The ID of the parent workflow, if applicable.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'XAttrs' => ['description' => 'The extended attributes.', 'type' => 'string', 'example' => '{"sessionId":"ac21f9f6-5a88-4f97-abd1-b51989166035"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Total' => ['description' => 'The total number of entries found.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], + ], [ - 'name' => 'Keyword', + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the job instance list ', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-05-20T09:00:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => 'Request parameters changed'], + ], + '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' => 'Lists the script history for a job.', + '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' => 'The ID of the cluster.', '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' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The ID of the job.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74', 'title' => ''], ], [ - 'name' => 'Reverse', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The maximum number of entries to return per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '10', 'default' => '10', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token to retrieve the next page of results. You do not need to set this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '- The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code. A value of `200` indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique ID for the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => '- The response data.', 'type' => 'object', 'properties' => [ 'Records' => [ - 'description' => '', + 'description' => '- A list of script history records.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => '- A script history record.', 'type' => 'object', 'properties' => [ - 'EventType' => [ - 'title' => '事件类型', - 'type' => 'string', - 'example' => 'JOB', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-app', - ], - 'JobName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-job', - ], - 'JobExecutionId' => [ - 'description' => '130', - 'type' => 'string', - 'example' => '1310630367761285120', - ], - 'WorkflowName' => [ - 'title' => '工作流名称', - 'type' => 'string', - 'example' => '工作流0001', - ], - 'WorkflowExecutionId' => [ - 'title' => '工作流执行记录ID', - 'type' => 'string', - 'example' => '1450568762586578000', - ], - 'Event' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INFO', - ], - 'WorkerAddr' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://192.168.1.5:9999/', - ], - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hello word'."\n", - ], - 'Time' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-31 16:43:51'."\n", - ], + 'VersionDescription' => ['description' => 'The script version description.', 'type' => 'string', 'example' => 'init version', 'title' => ''], + 'ScriptContent' => ['description' => 'The content of the script.', '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', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the script version was created.', 'type' => 'string', 'example' => '2025-06-29 15:56:36', 'title' => ''], + 'Creator' => ['description' => 'The creator of the script version.', 'type' => 'string', 'example' => '1963096506470832', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - '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' => 'The token to retrieve the next page of results. If this parameter is empty, no more data is available.', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], + 'Total' => ['description' => 'The total count of entries.', 'type' => 'string', 'example' => '21', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'MaxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve the job script history list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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' => 'ListScheduleEvent', ], - 'ListAlarmEvent' => [ - 'summary' => 'Obtains a list of alert events.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListJobs' => [ + 'summary' => 'Returns a task list.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobName', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-job', - ], + 'schema' => ['description' => 'The status of the job.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1690419316000', - ], + 'schema' => ['description' => 'The ID of the job.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'JobName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1731636011558', - ], + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'required' => false, 'example' => 'job01', 'title' => ''], ], [ - 'name' => 'AlarmType', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'schedulerx3_fail_alarm', - ], + 'schema' => ['description' => 'The description of the job.', 'type' => 'string', 'required' => false, 'example' => 'job01单机任务', 'title' => ''], ], [ - 'name' => 'AlarmChannel', + 'name' => 'JobHandler', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'webhook', - ], + 'schema' => ['description' => 'The name of the job handler.', 'type' => 'string', 'required' => false, 'example' => 'jobDemoHandler', 'title' => ''], ], [ - 'name' => 'AlarmStatus', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ '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', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Reverse', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['title' => 'Pipeline ID.', 'description' => 'The ID of the workflow.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The HTTP status code. A value of `200` indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'A unique ID that Alibaba Cloud generates for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => '- The returned data.', 'type' => 'object', 'properties' => [ 'Records' => [ - 'description' => '', + 'description' => '- A list of jobs.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => '- An object that represents a job.', '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' => '', - ], - 'Time' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-31 16:43:51'."\n", - ], + 'JobId' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '74', 'title' => ''], + 'Name' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'job01', 'title' => ''], + 'Description' => ['description' => 'The job description.', 'type' => 'string', 'example' => 'job01单机任务', 'title' => ''], + 'JobType' => ['description' => 'The job type.', 'type' => 'string', 'example' => 'xxljob', 'title' => ''], + 'Status' => ['description' => 'The job status. Valid values:'."\n" + ."\n" + .'- `0`: Disabled'."\n" + ."\n" + .'- `1`: Enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Parameters' => ['description' => 'The job parameters.', 'type' => 'string', 'example' => 'name=10', 'title' => ''], + 'MaxConcurrency' => ['description' => 'The maximum concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'MaxAttempt' => ['description' => 'The maximum number of retries for a failed job.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'AttemptInterval' => ['description' => 'The retry interval, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'JobHandler' => ['description' => 'The name of the job handler.', 'type' => 'string', 'example' => 'jobDemoHandler', 'title' => ''], + 'Priority' => ['description' => 'The job priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TimeType' => ['description' => 'The time type. Valid values:'."\n" + ."\n" + .'- `-1`: none'."\n" + ."\n" + .'- `1`: cron'."\n" + ."\n" + .'- `3`: fix\\_rate'."\n" + ."\n" + .'- `5`: one\\_time'."\n" + ."\n" + .'- `100`: api', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TimeExpression' => ['description' => 'The time expression.', 'type' => 'string', 'example' => '0 0 12 * * ?', 'title' => ''], + 'TimeZone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'Hongkong', 'title' => ''], + 'Calendar' => ['description' => 'The calendar.', 'type' => 'string', 'example' => 'work-day', 'title' => ''], + 'DataOffset' => ['description' => 'The data offset.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'CleanMode' => ['description' => 'The cleanup mode.', 'type' => 'string', 'example' => '{"cleanMode":"NUM_ONLY","totalRemain":300}', 'title' => ''], + 'Creator' => ['description' => 'The ID of the user who created the job.', 'type' => 'string', 'example' => '1963096506470832', 'title' => ''], + 'Updater' => ['description' => 'The ID of the user who last updated the job.', 'type' => 'string', 'example' => '1963096506470832', 'title' => ''], + 'Xattrs' => ['description' => 'The extended attributes.'."\n" + ."\n" + .'> This parameter is not currently supported.', 'type' => 'string', 'example' => '暂无', 'title' => ''], + 'NoticeConfig' => ['description' => 'The notification configuration.', 'type' => 'string', 'example' => '{"failLimitTimes":1,"failEnable":true,"timeoutKillEnable":false,"missWorkerEnable":true,"timeoutEnable":true,"sendChannel":"","timeout":300,"successNotice":false}', 'title' => ''], + 'NoticeContacts' => ['description' => 'The notification contacts.', 'type' => 'string', 'example' => '[{"contactType":1,"name":"恰橙"}]', 'title' => ''], + 'RouteStrategy' => ['description' => 'The routing strategy. Valid values:'."\n" + ."\n" + .'- `1`: Round-robin'."\n" + ."\n" + .'- `2`: Random'."\n" + ."\n" + .'- `3`: First'."\n" + ."\n" + .'- `4`: Last'."\n" + ."\n" + .'- `5`: Least Frequently Used'."\n" + ."\n" + .'- `6`: Least Recently Used'."\n" + ."\n" + .'- `7`: Consistent Hashing'."\n" + ."\n" + .'- `8`: Sharded Broadcast', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'HangKong', 'title' => ''], + 'LastExecuteEndTime' => ['description' => 'The time when the last execution ended.', 'type' => 'string', 'example' => '2025-06-29 15:56:36'."\n", 'title' => ''], + 'LastExecuteStatus' => ['description' => 'The status of the last execution. Valid values:'."\n" + ."\n" + .'- `4`: Success'."\n" + ."\n" + .'- `5`: Failure', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'CurrentExecuteStatus' => [ + 'description' => 'The current execution status. Valid values:'."\n" + ."\n" + .'- `0`: Not Started'."\n" + ."\n" + .'- `1`: Running'."\n" + ."\n" + .'- `2`: Queued'."\n" + ."\n" + .'- `3`: Waiting', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'enum' => ['0', '1', '2', '3'], + 'title' => '', + ], + 'ChildJobId' => ['description' => 'The child job ID.', 'type' => 'string', 'example' => '1246', 'title' => ''], + 'Weight' => ['title' => 'Job weight', 'description' => 'The job weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NodeType' => ['title' => 'File Type ', 'description' => 'The node type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DependentStrategy' => ['title' => 'Dependency Checking policy', 'description' => 'The dependency check strategy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Script' => ['description' => 'The script content.', 'type' => 'string', 'example' => '#!/bin/bash'."\n" + .'echo "xxl-job: hello shell"'."\n" + .'echo "Good bye!"'."\n" + .'exit 0', 'title' => ''], + 'WorkflowId' => ['title' => 'Pipeline ID', 'description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'ExecutorBlockStrategy' => ['description' => 'The executor blocking strategy. Valid values:'."\n" + ."\n" + .'- `1`: Serial Execution'."\n" + ."\n" + .'- `2`: Discard Later'."\n" + ."\n" + .'- `3`: Cover Earlier', 'type' => 'string', 'example' => '1', 'title' => ''], + 'StartTimeType' => ['title' => 'Start Time type', 'description' => 'The type of the start time.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - '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' => ['description' => 'The total number of jobs returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '65'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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' => 'ListAlarmEvent', - ], - 'ListScheduleTimes' => [ - 'summary' => 'Obtains the scheduling time points of the next five jobs. The scheduling time points are specified by time types or expressions.', - 'methods' => [ - 'get', + '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' => 'Retrieve Job List ', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-04T09:10:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-24T09:10:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-17T09:51:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-29T02:39:12.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobs'], + ], ], + ], + 'ListK8sResource' => [ + 'summary' => 'Lists k8s resources.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9311,443 +6907,382 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'K8sClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The ID of the Kubernetes cluster used for synchronizing namespaces. The cluster is added to the service mesh specified by ServiceMeshId. This parameter is required when you query a k8s namespace or a k8s service.', 'type' => 'string', 'required' => false, 'example' => 'cadb451ed7af04b0297f4be396a2196fc', 'title' => ''], ], [ - 'name' => 'TimeType', + 'name' => 'K8sNamespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'enum' => [ - '1', - ], - ], + 'schema' => ['description' => 'The name of the namespace in the k8s cluster. This parameter is required when you query a k8s service.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'TimeExpression', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The resource type.', 'type' => 'string', 'required' => true, - 'example' => '0 0/10 * * * ?', - ], - ], - [ - 'name' => 'TimeZone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Asia/Beijing', + 'enum' => ['cluster', 'namespace', 'service'], + 'example' => 'cluster', + 'title' => '', ], ], [ - 'name' => 'Calendar', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workday', - ], + 'schema' => ['description' => 'The VPC ID. This parameter is required if ResourceType is set to \'cluster\'.', 'type' => 'string', 'required' => false, 'example' => 'vpc-aa1a18236n90rqhuhhnhh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => '- An array of k8s resources.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-11-17 12:00:00', + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'ResourceName' => ['description' => 'The name of the k8s resource.', 'type' => 'string', 'example' => 'q_ecs_enterprise_spot_c', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the k8s resource.', 'type' => 'string', 'example' => 'xxljob-01632622cda2f', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Obtain k8s resources ', + 'description' => '# Add the enhancement plugin'."\n" + ."\n" + .'Add the enhancement plugin to your `pom.xml` file to extend the Executor\'s capabilities.'."\n" + ."\n" + .'**Note**: Place this plugin **above** the `xxl-job-core` dependency in your pom.xml file.'."\n" + ."\n" + .'**For more information:** [Plugin version release notes](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' => 'ListScheduleTimes', ], - 'ImportCalendar' => [ - 'summary' => 'Imports a calendar.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListLables' => [ + 'summary' => 'Retrieves a list of labels for an Executor.', + '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' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', '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' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '9079A828-9138-50F1-801E-F2BC3D222A06'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => 'The returned list of labels.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'refresh calendar success', + 'description' => 'An object containing the details of a label.', + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The label.', 'type' => 'string', 'example' => 'gray', 'title' => ''], + 'Online' => ['description' => 'Indicates whether the Executor is online.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Size' => ['description' => 'The number of machines with this label.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'IsDesignated' => ['description' => 'Indicates whether the label is designated.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Obtain the label list of the executor ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLables'], + ], ], - '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' => 'ImportCalendar', ], - 'ExportJobs' => [ - 'summary' => 'Exports the information about jobs at a time.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListRegionZone' => [ + 'summary' => 'Obtain the zone list.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', + 'title' => 'JSONResult', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '', + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['title' => 'zone id', 'description' => 'zone id', 'type' => 'string', 'example' => 'cn-beijing-j'], + 'LocalName' => ['title' => '', 'description' => 'Local name.', 'type' => 'string', 'example' => 'E'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Code' => ['title' => 'code', 'description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => 'IllegalRequest'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the invocation succeeded.'."\n" + .'- **true**: The invocation succeeded.'."\n" + .'- **false**: Failed to invoke.', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'Parameter check error'], + 'RequestId' => ['title' => '', 'description' => 'Request UUID.', 'type' => 'string', 'example' => '438737AC-760A-57D9-B646-B7EF79426243'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], + ], [ - 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - 'name' => 'JobIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], - 'required' => false, - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Obtain the zone list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegionZone'], + ], + ], + ], + 'ListRegions' => [ + 'summary' => 'Obtain the List of all Regions.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ExportJobType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - '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', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'Response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['description' => 'The ID of this request, which is a UUID generated by Alibaba Cloud for this request. It can be used for troubleshooting and issue tracking.', 'type' => 'string', 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded.'."\n" + .'- **true**: The invocation succeeded.'."\n" + .'- **false**: Failed to invoke.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Regions' => [ + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => ['title' => 'endpoint', 'description' => 'endpoint', 'type' => 'string', 'example' => 'schedulerx3.cn-hangzhou.aliyuncs.com'], + 'LocalName' => ['title' => '', 'description' => 'Local name.', 'type' => 'string', 'example' => 'China (Hangzhou)'], + 'RegionId' => ['title' => '', 'description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Obtain Region List', + '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' => 'ExportJobs', ], - 'GetLog' => [ - 'summary' => 'Queries logs.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListScheduleEvent' => [ + 'summary' => 'Lists scheduled events.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9756,729 +7291,817 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => ['description' => 'The job name.', 'type' => 'string', 'required' => false, 'example' => 'test-job', 'title' => ''], ], [ 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'int64', - 'required' => false, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The job execution ID.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], + ], + [ + 'name' => 'WorkflowName', + 'in' => 'query', + 'schema' => ['title' => 'Pipeline name.', 'description' => 'The workflow name.', 'type' => 'string', 'example' => '流程001', 'required' => false], + ], + [ + 'name' => 'WorkflowExecutionId', + 'in' => 'query', + 'schema' => ['title' => 'Pipeline execution ID.', 'description' => 'The workflow execution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1450568762586578000'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1721636220', - ], + 'schema' => ['description' => 'The start of the time range to query events. This is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1581317873000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1721636220', - ], + 'schema' => ['description' => 'The end of the time range to query events. This is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1728872796295', 'title' => ''], ], [ - 'name' => 'Level', + 'name' => 'Event', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INFO', - 'enum' => [ - 'INFO', - 'ERROR', - 'WARN', - 'DEBUG', - ], - ], + 'schema' => ['description' => 'The event status to filter by. Valid values:'."\n" + ."\n" + .'- Scheduled'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Succeeded'."\n" + ."\n" + .'- Failed'."\n" + ."\n" + .'- Failing\\_Auto\\_Retry'."\n" + ."\n" + .'- Skip\\_Schedule'."\n" + ."\n" + .'- Execute\\_Log', 'type' => 'string', 'required' => false, 'example' => 'Failed', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['title' => 'Management event type.', 'description' => 'The event type.', 'type' => 'string', 'required' => false, 'example' => 'JOB | WORKFLOW', 'default' => 'JOB'], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hello word', - ], + 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'hello word', 'title' => ''], ], [ - 'name' => 'Offset', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The number of events to return per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'LineNum', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'LineNum', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Reverse', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to sort the results in descending order. Set to `true` for descending order or `false` for ascending order. Default is `false`.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique identifier for the request, which is used to troubleshoot issues.', 'type' => 'string', 'example' => 'B880122A-B0E4-52E8-8F54-87DB7779EB74', 'title' => ''], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => 'The array of event records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The event record.', + 'type' => 'object', + 'properties' => [ + 'EventType' => ['title' => 'Event type ', 'description' => 'The event type.', 'type' => 'string', 'example' => 'JOB'], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'test-job', 'title' => ''], + 'JobExecutionId' => ['description' => 'The job execution ID.', 'type' => 'string', 'example' => '1310630367761285120', 'title' => ''], + 'WorkflowName' => ['title' => 'Pipeline name ', 'description' => 'The workflow name.', 'type' => 'string', 'example' => '工作流0001'], + 'WorkflowExecutionId' => ['title' => 'Pipeline execution record ID', 'description' => 'The workflow execution ID.', 'type' => 'string', 'example' => '1450568762586578000'], + 'Event' => ['description' => 'The event status.', 'type' => 'string', 'example' => 'Failed', 'title' => ''], + 'WorkerAddr' => ['description' => 'The worker address.', 'type' => 'string', 'example' => 'http://192.168.1.5:9999/', 'title' => ''], + 'Content' => ['description' => 'The event content.', 'type' => 'string', 'example' => 'hello word'."\n", 'title' => ''], + 'Time' => ['description' => 'The timestamp of the event. The time is in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2024-10-31 16:43:51'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], + ], [ - 'name' => 'LogId', + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], + ], + [ + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], + ], + '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' => 'Query schedule events ', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:17.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-05-20T09:00:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-27T12:09:48.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduleEvent'], + ], + ], + ], + 'ListScheduleTimes' => [ + 'summary' => 'Retrieves the next five scheduled times based on the specified time type and time expression.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227423', + 'abilityTreeNodes' => ['FEATUREmseCPRKIU'], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '344008', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'], ], [ - 'name' => 'WorkerAddr', + 'name' => 'AppName', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '执行器地址', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.1.100', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'ScheduleTime', + 'name' => 'TimeType', 'in' => 'query', 'schema' => [ - 'title' => '调度时间', + 'description' => 'The time type. The only supported type is cron.'."\n" + ."\n" + .'- 1: cron', 'type' => 'integer', - 'format' => 'int64', - 'example' => '2023-10-01 12:00:00', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => ['1'], + 'title' => '', ], ], + [ + 'name' => 'TimeExpression', + 'in' => 'query', + 'schema' => ['description' => 'The time expression, such as a cron expression.', 'type' => 'string', 'required' => true, 'example' => '0 0/10 * * * ?', 'title' => ''], + ], + [ + 'name' => 'TimeZone', + 'in' => 'query', + 'schema' => ['description' => 'The time zone used to evaluate the time expression.', 'type' => 'string', 'required' => false, 'example' => 'Asia/Beijing', 'title' => ''], + ], + [ + 'name' => 'Calendar', + 'in' => 'query', + 'schema' => ['description' => 'The name of the calendar to use for scheduling, such as a business day calendar.', 'type' => 'string', 'required' => false, 'example' => 'workday', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], + 'Code' => ['description' => 'The response code. `200` indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message. The value is `success` if the request succeeds, or an error message if it fails.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. Use this ID for troubleshooting.', 'type' => 'string', 'example' => '9A48E22F-F30A-5CE5-AC7A-E0FED1B6942E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => 'A list of the scheduled times.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ip : 10.10.116.53:58098'."\n" - .'executionId : 74_1310630367761285120_0'."\n" - .'level : INFO'."\n" - .'log : hello word!;'."\n" - .'time : 2024-10-31 16:43:51', - ], + 'items' => ['description' => 'A scheduled time in `YYYY-MM-DD hh:mm:ss` format.', 'type' => 'string', 'example' => '2024-11-17 12:00:00', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Obtain the next five scheduled times for the specified time type and expression', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListScheduleTimes'], + ], ], - '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' => 'GetLog', ], - 'OperateMarkSuccessWorkflowExecution' => [ - 'summary' => '将工作流实例标记为成功', + 'ListWorkflowExecutions' => [ + 'summary' => 'Retrieves a list of workflow instances.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + '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', + 'abilityTreeNodes' => ['FEATUREmsePN2NBR'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-d6a5243b6fa', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxl-job-executor-sample', - ], + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'WorkflowName', + 'in' => 'query', + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => false, 'example' => 'myWorkflow', 'title' => ''], ], [ 'name' => 'WorkflowExecutionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'in' => 'query', + 'schema' => ['description' => 'The workflow execution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The workflow execution status. Use this parameter to filter executions by status. Valid values:'."\n" + ."\n" + .'- 0: unknown'."\n" + ."\n" + .'- 1: waiting'."\n" + ."\n" + .'- 2: queued'."\n" + ."\n" + .'- 3: running'."\n" + ."\n" + .'- 4: success'."\n" + ."\n" + .'- 5: failed'."\n" + ."\n" + .'- 6: killed'."\n" + ."\n" + .'- 7: held'."\n" + ."\n" + .'- 8: mark\\_success'."\n" + ."\n" + .'- 9: skipped', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range for filtering executions. The time must be in `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2025-10-27 02:15:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range for filtering executions. The time must be in `YYYY-MM-DD HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2025-10-13 16:00:00', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return. Defaults to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token to retrieve the next page of results. For the first request, do not specify this parameter. If the response does not include a `NextToken`, no more results are available.', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The root object of the 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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', + 'Code' => ['description' => 'The response code. A value of `200` indicates a successful request.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '200'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'], + 'Message' => ['description' => 'The response message. If the request fails, this parameter provides details about the error.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Parameter error: content is null.'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => '-', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'WorkflowExecutionId' => ['description' => 'The workflow execution ID.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'WorkflowName' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'myWorkflow', 'title' => ''], + 'ScheduleTime' => ['description' => 'The schedule time of the workflow execution.', 'type' => 'string', 'example' => '2024-11-12 14:52:42', 'title' => ''], + 'DataTime' => ['description' => 'The data time of the workflow execution.', 'type' => 'string', 'example' => '2024-11-12 14:52:42', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the workflow execution.', 'type' => 'string', 'example' => '2025-11-04 01:09:27', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the workflow execution.', 'type' => 'string', 'example' => '2024-11-12 14:52:42', 'title' => ''], + 'Executor' => ['description' => 'The executor ID.', 'type' => 'string', 'example' => '1827811800526000', 'title' => ''], + 'Status' => ['description' => 'The status of the workflow execution. Valid values:'."\n" + ."\n" + .'- 0: UNKNOWN'."\n" + ."\n" + .'- 1: WAITING'."\n" + ."\n" + .'- 2: READY'."\n" + ."\n" + .'- 3: RUNNING'."\n" + ."\n" + .'- 4: SUCCESS'."\n" + ."\n" + .'- 5: FAILED'."\n" + ."\n" + .'- 6: PAUSED'."\n" + ."\n" + .'- 7: SUBMITTED'."\n" + ."\n" + .'- 8: REJECTED'."\n" + ."\n" + .'- 9: ACCEPTED'."\n" + ."\n" + .'- 10: PARTIAL\\_FAILED'."\n" + ."\n" + .'- 11: SKIPPED'."\n" + ."\n" + .'- 12: REMOVED', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Total' => ['description' => 'The total number of matching workflow executions.', 'type' => 'integer', 'format' => 'int32', 'example' => '65', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'MaxResults' => ['description' => 'The maximum number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is not returned, all results have been returned.', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve the workflow instance list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateSkipJobExecution' => [ - 'summary' => '跳过任务实例', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListWorkflowVersions' => [ + 'summary' => 'Lists the versions for a specified workflow.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227437', - 'abilityTreeNodes' => [ - 'FEATUREmseP3AH6A', - ], + 'abilityTreeCode' => '227452', + 'abilityTreeNodes' => ['FEATUREmsePN2NBR'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-d6a5243b6fa', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxl-job-executor-sample', 'title' => ''], ], [ - 'name' => 'JobExecutionId', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token to retrieve the next page of results. Omit this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request. Use this Request ID to troubleshoot issues.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'A list of workflow versions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the workflow version.', + 'type' => 'object', + 'properties' => [ + 'DagVersion' => ['description' => 'The version number.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Current' => ['description' => 'Indicates whether this is the current active version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-10-29 15:56:36', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'The token to retrieve the next page of results. An empty value indicates that no more results are available.', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Retrieve the pipeline version list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'UpdateWorkflow' => [ - 'summary' => '更新工作流', + 'ListWorkflows' => [ + 'summary' => 'Lists your workflows.', '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', - ], + 'abilityTreeCode' => '227452', + 'abilityTreeNodes' => ['FEATUREmsePN2NBR'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-d6a5243b6fa', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - 'maxLength' => 64, - 'minLength' => 1, - 'pattern' => '^[0-9a-zA-Z_-]+$', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the workflow. If this parameter is not specified, workflows in the `disabled` state are returned by default. Valid values:'."\n" + ."\n" + .'- `0`: disabled'."\n" + ."\n" + .'- `1`: enabled', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'WorkflowId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workflow.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myWorkflow', - 'maxLength' => 32, - 'minLength' => 6, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the workflow.', 'type' => 'string', 'required' => false, 'example' => 'myWorkflow', 'title' => ''], ], [ 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'my first workflow', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'TimeType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'TimeExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0/10 * * * ?', - ], + 'in' => 'query', + 'schema' => ['description' => 'The description of the workflow.', 'type' => 'string', 'required' => false, 'example' => 'my first workflow', 'title' => ''], ], [ - 'name' => 'Timezone', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GMT+8', - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Calendar', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workday', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'default' => '20', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'MaxConcurrency', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. If the return value is empty, no more data is returned.', 'type' => 'string', 'required' => false, 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID that is generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Records' => [ + 'description' => 'The list of workflows.', + 'type' => 'array', + 'items' => [ + 'description' => 'The basic information about the workflow.', + 'type' => 'object', + 'properties' => [ + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Name' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'myWorkflow', 'title' => ''], + 'Description' => ['description' => 'The workflow description.', 'type' => 'string', 'example' => 'my first workflow', 'title' => ''], + 'Status' => ['description' => 'The status of the workflow. Valid values:'."\n" + ."\n" + .'- `0`: disabled'."\n" + ."\n" + .'- `1`: enabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'MaxConcurrency' => ['description' => 'The maximum number of concurrent instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'TimeType' => ['description' => 'The scheduling type. The following types are supported:'."\n" + ."\n" + .'- `-1`: none'."\n" + ."\n" + .'- `1`: cron'."\n" + ."\n" + .'- `100`: api', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TimeExpression' => ['description' => 'The time expression.', 'type' => 'string', 'example' => '0 0 12 * * ?', 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'HangKong', 'title' => ''], + 'Calendar' => ['description' => 'The calendar.', 'type' => 'string', 'example' => 'work-day', 'title' => ''], + 'Creator' => ['description' => 'The user who created the workflow.', 'type' => 'string', 'example' => '1963096506470832', 'title' => ''], + 'Updater' => ['description' => 'The user who last updated the workflow.', 'type' => 'string', 'example' => '1963096506470832', 'title' => ''], + 'Xattrs' => ['description' => 'The extended attributes.'."\n" + ."\n" + .'> This parameter is not supported.', 'type' => 'string', 'example' => '暂无', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'LastExecuteEndTime' => ['description' => 'The time when the last execution ended.', 'type' => 'string', 'example' => '2025-06-29 15:56:36'."\n", 'title' => ''], + 'LastExecuteStatus' => ['description' => 'The result of the last execution. Valid values:'."\n" + ."\n" + .'- `4`: success'."\n" + ."\n" + .'- `5`: failed', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'CurrentExecuteStatus' => [ + 'description' => 'The current execution status. Valid values:'."\n" + ."\n" + .'- `0`: not started'."\n" + ."\n" + .'- `1`: running'."\n" + ."\n" + .'- `2`: in queue'."\n" + ."\n" + .'- `3`: waiting', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'enum' => ['0', '1', '2', '3'], + 'title' => '', + ], + 'AppType' => ['description' => 'The application type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NextToken' => ['description' => 'If the query does not return all results, this token is returned. You can use this token to retrieve the next page of results. You do not need to specify this parameter for the first request.', 'type' => 'string', 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'List pipelines ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateEnableWorkflows' => [ - 'summary' => '批量启用工作流', + 'OperateBackfillWorkflow' => [ + 'summary' => 'Backfills historical data for a specified workflow.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10487,293 +8110,174 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227450', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], + 'abilityTreeCode' => '227436', + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxl-job-executor-sample', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowIds', + 'name' => 'WorkflowId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => ['description' => 'The start date of the backfill, in YYYY-MM-DD format.', 'type' => 'string', 'required' => true, 'example' => '2025-11-01', 'title' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end date of the backfill, in YYYY-MM-DD format.', 'type' => 'string', 'required' => true, 'example' => '2025-11-03', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.'."\n", - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID generated for the request.', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73'], + 'Code' => ['description' => 'The HTTP status code. A value of `200` indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Backfill Historical Data for Pipeline ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'CreateCalendar' => [ - 'summary' => '创建日历', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateConnectDatasource' => [ + 'summary' => 'Connect to a data source ', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmse8UT78G', - ], + 'abilityTreeCode' => '227426', + 'abilityTreeNodes' => ['FEATUREmseWTWX7C'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'Cluster ID ', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'CalendarName', + 'name' => 'Type', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workday', - ], + 'schema' => ['description' => 'Type of the data source. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Year', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2026', - ], - ], - [ - 'name' => 'Months', + 'name' => 'ConnectionParams', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => '', - '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" - .']', - ], + 'schema' => ['description' => 'Connection parameters of the data source ', 'type' => 'string', 'required' => true, 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'Password', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123456789', - ], + 'schema' => ['description' => 'Password of the database user. ', 'type' => 'string', 'required' => true, 'example' => '***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response ', + 'title' => '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'ID of the request ', 'title' => 'ID of the request ', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'], + 'Code' => ['description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. '."\n" + .'- true: The invocation succeeded. '."\n" + .'- false: The invocation failed. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Test connection to a data source ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', + '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"}]', + 'translator' => 'machine', ], - 'ImportWorkflows' => [ - 'summary' => '批量导入工作流', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateDesignateExecutors' => [ + 'summary' => 'Designates one or more executors for a job.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10785,52 +8289,58 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227422', - 'abilityTreeNodes' => [ - 'FEATUREmse7UN7CQ', - ], + 'abilityTreeCode' => '227425', + 'abilityTreeNodes' => ['FEATUREmseWGXOHM'], ], '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' => ['title' => 'A short description of struct', 'description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx'], ], [ - 'name' => 'Overwrite', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'Content', + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74', 'title' => ''], + ], + [ + 'name' => 'Transferable', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable failover.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DesignateType', '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"}]}]', + 'description' => 'The designation type. Valid values:'."\n" + ."\n" + .'- **1**: By worker.'."\n" + ."\n" + .'- **2**: By label.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => ['1', '2'], + 'title' => '', ], ], [ - 'name' => 'AutoCreateApp', + 'name' => 'AddressList', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'A list of machine addresses to designate.', + 'type' => 'array', + 'items' => ['description' => 'A machine address.', 'type' => 'string', 'required' => false, 'example' => 'http://192.168.***.5:9999/', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -10838,286 +8348,143 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code. A value of `200` indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID generated for the request. Use this ID for troubleshooting.', 'type' => 'string', 'example' => 'AFD5B166-4A7D-50DF-91BF-EFAFD41F7335', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Specify the executor', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateDesignateExecutors'], + ], ], - '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"}]', ], - 'GetWorkflow' => [ - 'summary' => '获取工作流', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateDisableJobs' => [ + 'summary' => 'Disables multiple jobs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227452', - 'abilityTreeNodes' => [ - 'FEATUREmsePN2NBR', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '227445', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxl-job-executor-sample', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowId', - 'in' => 'query', + 'name' => 'JobIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The IDs of the jobs to disable.', + 'type' => 'array', + 'items' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74', 'title' => ''], 'required' => true, - 'example' => '20', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The API response.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'WorkflowId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'myWorkflow', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my first workflow', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'MaxConcurrency' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TimeType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TimeExpression' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0 0 12 * * ?', - ], - 'Timezone' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-app', - ], - ], - ], + 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. Contains error details if the request fails.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'A unique ID generated for this request. If you encounter an issue, provide this ID for troubleshooting.', 'type' => 'string', 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF', 'title' => ''], + 'Success' => ['description' => 'Indicates if the request succeeded.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Disable jobs in batch.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateDisableJobs'], + ], ], - '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"}]', ], - 'OperateUnskipJobExecution' => [ - 'summary' => '将skipped状态的任务恢复', + 'OperateDisableWorkflows' => [ + 'summary' => 'Disables one or more workflows.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11126,43 +8493,35 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227437', - 'abilityTreeNodes' => [ - 'FEATUREmseP3AH6A', - ], + 'abilityTreeCode' => '227449', + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobExecutionId', - 'in' => 'query', + 'name' => 'WorkflowIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1310630367761285120', + 'description' => 'A list of workflow IDs.', + 'type' => 'array', + 'items' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -11170,241 +8529,180 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID for troubleshooting.', 'type' => 'string', 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Disable pipeline', + 'description' => 'Disables one or more specified workflows.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'ExportWorkflows' => [ - 'summary' => '批量导出工作流信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateEnableJobs' => [ + 'summary' => 'Enables multiple jobs in a batch.', + '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' => '227450', + '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' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'WorkflowId', + 'name' => 'AppName', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'JobIds', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The IDs of the jobs to enable.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the job.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74', 'title' => ''], 'required' => true, - 'example' => 'test-app', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], ], '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' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID generated for the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4CC4132F-B798-5D6E-9F06-D44B33E417E9', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- `true`: The call was successful.'."\n" + ."\n" + .'- `false`: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Batch enable jobs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateEnableJobs'], + ], ], - '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"}]', ], - 'GetWorkflowDAG' => [ - 'summary' => '获取工作流的DAG信息', + 'OperateEnableWorkflows' => [ + 'summary' => 'Enables one or more workflows.', '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', - ], + 'abilityTreeCode' => '227450', + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-a1804a3226d', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'xxl-job-executor-sample', 'title' => ''], ], [ - 'name' => 'WorkflowId', - 'in' => 'query', + 'name' => 'WorkflowIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', + 'description' => 'A list of workflow IDs.', + 'type' => 'array', + 'items' => ['description' => 'A workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], ], @@ -11412,369 +8710,156 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned by the request.', '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'job1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oak-payment-async-job', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'JobType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'script_shell', - ], - 'Coordinate' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'X' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '50', - ], - 'Y' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Target' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code. A value of `200` indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Enable pipeline', + '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"}]', ], - 'ListWorkflowVersions' => [ - 'summary' => '获取当前工作流版本列表', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateExecuteJob' => [ + 'summary' => 'Executes a job on demand.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227452', - 'abilityTreeNodes' => [ - 'FEATUREmsePN2NBR', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '227439', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxl-job-executor-sample', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '74', 'title' => ''], ], [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'InstanceParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The custom parameters for the job instance.', 'type' => 'string', 'required' => false, 'example' => 'name=zhangsan', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], + 'name' => 'Worker', + 'in' => 'formData', + 'schema' => ['description' => 'The address (`workerAddr`) of a specific worker.', 'type' => 'string', 'example' => 'http://192.168.***.5:9999/', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Label', + 'in' => 'formData', + 'schema' => ['description' => 'The label used to select a specific worker.', 'type' => 'string', 'example' => 'gray', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '6305893D-517D-5131-A767-644EDA81CEC3', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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', - ], - ], + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'JobExecutionId' => ['description' => 'The job execution ID.', 'type' => 'string', 'example' => '1310630367761285120', 'title' => ''], ], - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Run a job once', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateExecuteJob'], + ], ], - '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"}]', ], - 'OperateHoldJobExecution' => [ - 'summary' => 'Hold住任务实例', + 'OperateExecuteWorkflow' => [ + 'summary' => 'Executes a workflow.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11783,124 +8868,89 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227437', - 'abilityTreeNodes' => [ - 'FEATUREmseP3AH6A', - ], + 'abilityTreeCode' => '227439', + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobExecutionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1310630367761285120', - ], + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'WorkflowExecutionId' => ['description' => 'The workflow instance ID.', 'type' => 'string', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Run a pipeline once ', + 'description' => 'This operation starts a new workflow instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'DeleteCalendar' => [ - 'summary' => '删除日历', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateHoldJobExecution' => [ + 'summary' => 'Holds a pending job execution.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11909,127 +8959,79 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227426', - 'abilityTreeNodes' => [ - 'FEATUREmse8UT78G', - ], + 'abilityTreeCode' => '227437', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'CalendarName', - 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workday', - ], + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'Year', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], + 'name' => 'JobExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the job execution.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response body.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2ECA6FC9-7557-5576-AF5F-FC3E7BCC9C21'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Suspend task instances that have not been executed yet ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'UpdateWorkflowDAG' => [ - 'summary' => '更新工作流DAG', + 'OperateHoldWorkflowExecution' => [ + 'summary' => 'Puts a Workflow Execution on hold, suspending all its unexecuted nodes.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12038,291 +9040,80 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-a1804a3226d', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ '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' => 'WorkflowId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Dag', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Nodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'Coordinate' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'X' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '50', - ], - 'Y' => [ - 'description' => '', - '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' => '', - 'type' => 'object', - 'properties' => [ - 'Source' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], - 'Target' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'xxl-job-executor-sample', 'title' => ''], ], [ - 'name' => 'DagVersion', + 'name' => 'WorkflowExecutionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1137005', - ], + 'schema' => ['description' => 'The ID of the Workflow Execution.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The root object for the response data.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID generated for this request.', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'], + 'Code' => ['description' => 'The Response Code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The Error Message returned if the request fails.', 'type' => 'string', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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\\": \\"not support query script history, please upgrade engine version to 2.2.2+\\"\\n}","type":"json"}]', + 'title' => 'Suspend Workflow Instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateUnholdJobExecution' => [ - 'summary' => '将held状态的任务恢复', + 'OperateMarkSuccessJobExecution' => [ + 'summary' => 'Marks a job execution as successful.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12331,126 +9122,79 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-d6a5243b6fa', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The job execution ID.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.'."\n" + ."\n" + .'- `true`: The call was successful.'."\n" + ."\n" + .'- `false`: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Mark a task instance as Succeeded', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateHoldWorkflowExecution' => [ - 'summary' => '将工作流中未开始的节点置为Held状态', + 'OperateMarkSuccessWorkflowExecution' => [ + 'summary' => 'Marks a workflow execution as successful.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12463,124 +9207,75 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227436', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-d6a5243b6fa', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxl-job-executor-sample', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'xxl-job-executor-sample', 'title' => ''], ], [ 'name' => 'WorkflowExecutionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => 'The ID of the workflow execution.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - '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' => 'The unique ID of the request, used for troubleshooting.', 'type' => 'string', 'example' => '1DF6732E-15D8-5E1F-95E3-C10077F556B5'], + 'Code' => ['description' => 'The response code. A value of `200` indicates a successful request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates if the operation succeeded.'."\n" + ."\n" + .'- `true`: The operation succeeded.'."\n" + ."\n" + .'- `false`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'Additional details about the result.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Mark a workflow instance as succeeded', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateBackfillWorkflow' => [ - 'summary' => '补数工作流', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateRerunJob' => [ + 'summary' => 'Reruns historical data for a job within a specified time range.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12592,144 +9287,92 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227436', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '227442', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the job.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74', 'title' => ''], ], [ 'name' => 'StartDate', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-11-01', - ], + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to rerun, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1698458024000', 'title' => ''], ], [ 'name' => 'EndDate', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-11-03', - ], + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to rerun, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1698458024000', 'title' => ''], + ], + [ + 'name' => 'DataTime', + 'in' => 'query', + 'schema' => ['description' => 'The specific time of day for which to rerun the data. The format is `HH:mm:ss`.', 'type' => 'string', 'required' => true, 'example' => '14:11:10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A unique identifier for the request, generated by Alibaba Cloud. Use this ID for troubleshooting.', 'type' => 'string', 'example' => 'BCDF4006-C8A1-5F83-9368-588347D3EE84'], + 'Code' => ['description' => 'The response code. A value of `200` indicates that the request succeeded.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Refresh historical data of a job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateRerunJob'], + ], ], - '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"}]', ], - 'DeleteWorkflows' => [ - 'summary' => '批量删除工作流', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateRetryJobExecution' => [ + 'summary' => 'Retries a failed Job Instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12738,144 +9381,105 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227449', - 'abilityTreeNodes' => [ - 'FEATUREmsePN2NBR', - ], + 'abilityTreeCode' => '227436', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-a1804a3226d', - ], + 'in' => 'query', + 'schema' => ['description' => 'The Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'in' => 'query', + 'schema' => ['description' => 'The Application Name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowIds', - 'in' => 'formData', + 'name' => 'JobExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The Job Execution ID.', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120', 'title' => ''], + ], + [ + 'name' => 'TaskList', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'A list of Sub-task execution IDs for a Broadcast Sharding Job.'."\n" + ."\n" + .'> To retry a specific Sub-task of a Broadcast Sharding Job, set this parameter to the execution ID of that Sub-task.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'required' => true, - 'docRequired' => true, + 'items' => ['description' => 'The Sub-task execution ID.', 'type' => 'string', 'required' => false, 'example' => '1311649782220996611'."\n", 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DeleteJobs', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否删除工作流下的所有任务', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'name' => 'TriggerChild', + 'in' => 'query', + 'schema' => ['title' => 'Specifies whether to trigger downstream jobs.', 'description' => 'Specifies whether to trigger downstream jobs.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique Request ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '438737AC-760A-57D9-B646-B7EF79426243'], + 'Code' => ['description' => 'The Response Code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'Returns `success` for successful requests, and an error message for failed requests.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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"}]', - ], - 'UpdateCalendar' => [ - 'summary' => '更新日历', - 'methods' => [ - 'post', + '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' => 'Rerun task instance', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-28T05:40:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-27T12:09:49.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateRetryJobExecution'], + ], ], + ], + 'OperateRetryWorkflowExecution' => [ + 'summary' => 'Retries a workflow execution.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12884,159 +9488,85 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmse8UT78G', - ], + 'abilityTreeCode' => '227436', + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'CalendarName', - 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workday', - ], - ], - [ - 'name' => 'Year', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - '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', + 'name' => 'WorkflowExecutionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The workflow execution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1450568762586578000', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'OnlyFailed', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', - ], + 'schema' => ['description' => 'Set to `true` to rerun only failed nodes.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call succeeded.'."\n" + ."\n" + .'- true: The call succeeded.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Rerun pipeline instance ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateRetryWorkflowExecution' => [ - 'summary' => '重跑工作流实例', + 'OperateSkipJobExecution' => [ + 'summary' => 'Skips a job execution.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13048,134 +9578,75 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227436', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '227437', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], - ], - [ - 'name' => 'WorkflowExecutionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1450568762586578000', - ], + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'OnlyFailed', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'name' => 'JobExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The job execution ID.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true: The request succeeded.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Skip task instance ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3835AA29-2298-5434-BC53-9CC377CDFD2C\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]', ], - 'UpdateWorkflowDAGVersion' => [ - 'summary' => '切换工作流DAG版本', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'OperateStopJobExecution' => [ + 'summary' => 'Stops a running Job Execution.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13184,59 +9655,39 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227447', - 'abilityTreeNodes' => [ - 'FEATUREmseWTWX7C', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '227437', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - 'maxLength' => 64, - 'minLength' => 1, - 'pattern' => '^[0-9a-zA-Z_-]+$', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the Application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => 'JobExecutionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Job Execution.', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120', 'title' => ''], ], [ - 'name' => 'DagVersion', - 'in' => 'formData', + 'name' => 'TaskList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', + 'description' => 'A list of Task IDs.', + 'title' => 'Subtask ID ', + 'type' => 'array', + 'items' => ['title' => 'Subtask ID ', 'description' => 'A Task ID.', 'type' => 'string', 'example' => '[1,2,3]', 'required' => false], + 'required' => false, + 'example' => '', ], ], ], @@ -13244,825 +9695,299 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'E82D8B33-204D-58E1-8F56-909F6B48F3D1'], + 'Code' => ['description' => 'The Response Code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. A value of **true** indicates success, and a value of **false** indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Stop a running task instance ', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-28T05:40:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-27T12:09:49.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateStopJobExecution'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter check error\\",\\n \\"RequestId\\": \\"C78E2AD2-5985-515B-BAD2-31A248AFC263\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'GetCalendar' => [ - 'summary' => '获取日历信息', + 'OperateStopWorkflowExecution' => [ + 'summary' => 'Stops a running workflow execution.', '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, + 'abilityTreeCode' => '227436', + 'abilityTreeNodes' => ['FEATUREmse4EL0AA'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d', 'title' => ''], ], [ - 'name' => 'CalendarName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'workday', - ], + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'Year', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2024', - ], + 'name' => 'WorkflowExecutionId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow execution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - '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' => 'The request ID.', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Stop a running pipeline instance ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'GetWorkflowExecutionDAG' => [ - 'summary' => '获取工作流实例DAG信息', + 'OperateUnholdJobExecution' => [ + 'summary' => 'Resumes a Job Execution that is in the Hold state.', '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' => '260227', - 'abilityTreeNodes' => [ - 'FEATUREmsePN2NBR', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '227437', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The Application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowExecutionId', + 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => 'The Job Execution ID.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'JobType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'script_shell', - ], - 'Coordinate' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'X' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '50', - ], - 'Y' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '50', - ], - 'Width' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'Height' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - ], - ], - 'JobId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - ], - ], - ], - 'Edges' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - 'Target' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1001', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The Request ID.', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'], + 'Code' => ['description' => 'The Response Code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The Error Message.', 'type' => 'string', 'example' => 'Parameter error: content is null.'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded:'."\n" + ."\n" + .'- true: The request succeeded.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Cancel suspension of a task instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'ListWorkflows' => [ - 'summary' => '获取工作流列表', + 'OperateUnholdWorkflowExecution' => [ + 'summary' => 'Resumes a workflow execution that is on hold.', '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test-app', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'WorkflowId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], + 'name' => 'WorkflowExecutionId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow execution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Contains the response data.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '39938688-0BAB-5AD8-BF02-F4910FAC7589', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Records' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'WorkflowId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'myWorkflow', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my first workflow', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxConcurrency' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TimeType' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test-app', - ], - 'LastExecuteEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-06-29 15:56:36'."\n", - ], - 'LastExecuteStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'CurrentExecuteStatus' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Cancel suspension of a workflow instance ', + '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"}]', ], - 'OperateMarkSuccessJobExecution' => [ - 'summary' => '标记任务实例为成功状态', + 'OperateUnskipJobExecution' => [ + 'summary' => 'Resumes a skipped job execution.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14071,362 +9996,177 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ 'name' => 'JobExecutionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1310630367761285120', - ], + 'schema' => ['description' => 'The ID of the job execution.', 'type' => 'string', 'required' => false, 'example' => '1310630367761285120', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Parameter check error'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Cancel a skipped task instance ', + '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"}]', ], - 'CreateWorkflow' => [ - 'summary' => '创建应用', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SyncJobs' => [ + 'summary' => 'Synchronizes jobs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227447', - 'abilityTreeNodes' => [ - 'FEATUREmsePN2NBR', - ], + 'abilityTreeCode' => '227445', + 'abilityTreeNodes' => ['FEATUREmseP3AH6A'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'OriginalClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The ID of the source cluster that contains the jobs.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-00ed7f0d742b1', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'OriginalAppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxl-job-executor-sample', - 'maxLength' => 64, - 'minLength' => 1, - 'pattern' => '^[0-9a-zA-Z_-]+$', - ], + 'schema' => ['description' => 'The name of the source application that contains the jobs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-source', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'JobIds', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'A list of job IDs.', + 'type' => 'array', + 'items' => ['description' => 'A job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '56', 'title' => ''], 'required' => true, - 'example' => 'my-workflow', - 'maxLength' => 100, - 'minLength' => 6, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'my first workflow for data analyse', - 'maxLength' => 64, - 'minLength' => 0, - ], - ], - [ - 'name' => 'TimeType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '-1', - 'enum' => [ - '-1', - '1', - '100', - ], - ], - ], - [ - 'name' => 'TimeExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0 0 4 ? * Mon/1'."\n", - ], - ], - [ - 'name' => 'Calendar', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workday', - ], - ], - [ - 'name' => 'Timezone', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'GMT+8', - ], - ], - [ - 'name' => 'MaxConcurrency', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Status', + 'name' => 'TargetClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The ID of the destination cluster.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-008bfb1541111', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'TargetAppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123456789', - ], + 'schema' => ['description' => 'The name of the destination application.', 'type' => 'string', 'required' => true, 'example' => 'test-target', 'title' => ''], ], ], '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' => '', - 'type' => 'string', - 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'WorkflowId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Not found: appName not found.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. This ID is used for troubleshooting.', 'type' => 'string', 'example' => '6BCE89B3-E882-511D-9A75-D452A56EC4B1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'The response body.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Sync task', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateDisableWorkflows' => [ - 'summary' => '批量禁用工作流', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateApp' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14438,131 +10178,111 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227449', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], + 'abilityTreeCode' => '227448', + 'abilityTreeNodes' => ['FEATUREmseWTWX7C'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowIds', + 'name' => 'AccessToken', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The access token.', 'type' => 'string', 'maxLength' => 32, 'minLength' => 6, 'pattern' => '^[\\w.-]+$', 'required' => false, 'example' => 'f312159702f4469585586ed5a6904163v3', 'title' => ''], + ], + [ + 'name' => 'Title', + 'in' => 'formData', + 'schema' => ['description' => 'The title.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 1, 'example' => '测试应用', 'title' => ''], + ], + [ + 'name' => 'MaxConcurrency', + 'in' => 'formData', + 'schema' => ['description' => 'The task execution queue size.'."\n" + ."\n" + .'> Sets the maximum number of concurrent task instances in the application group. Additional task instances are queued for execution and not discarded.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'EnableLog', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable logging.'."\n" + ."\n" + .'- `true`: Enables logging.'."\n" + ."\n" + .'- `false`: Disables logging.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'LabelRouteStrategy', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'WorkerId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The object that contains the response data.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5EF879D0-3B43-5AD1-9BF7-52418F9C5E73', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request, generated by Alibaba Cloud. You can use this request ID to troubleshoot issues.', 'type' => 'string', 'example' => '39AA91C1-7BB7-5934-B15B-FD8E706D76C4'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - '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"}]', - ], - 'OperateUnholdWorkflowExecution' => [ - 'summary' => '将工作流中held状态的节点恢复', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Application', + 'summary' => 'Updates an application group.', + 'changeSet' => [ + ['createdAt' => '2025-07-11T06:03:46.000Z', 'description' => 'Request parameters changed'], ], - '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' => 'Updates a calendar.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14571,127 +10291,96 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227436', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREmse8UT78G'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'CalendarName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The calendar name.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'workday'], ], [ - 'name' => 'WorkflowExecutionId', + 'name' => 'Year', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => 'The year.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2024', 'title' => ''], + ], + [ + 'name' => 'Months', + 'in' => 'formData', + 'schema' => ['description' => 'A JSON string that defines the days for one or more months.', 'type' => 'string', 'title' => '', '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' => 'Specifies whether to perform an incremental update. Default value: `false`.'."\n" + ."\n" + .'- `false`: Replaces all existing calendar data with the data in this request, deleting configurations for any unspecified months.'."\n" + ."\n" + .'- `true`: Updates only the data for the specified months, preserving existing configurations for all other months.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'A client-generated token that ensures request idempotence. This token must be unique for each request and be no more than 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %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' => 'Update calendar', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'OperateExecuteWorkflow' => [ - 'summary' => '运行一次工作流', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateCluster' => [ + 'summary' => 'Updates a cluster.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14700,139 +10389,81 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '227439', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '227451', + 'abilityTreeNodes' => ['FEATUREmse8UT78G'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-c20f7ec9a78'], ], [ - 'name' => 'AppName', + 'name' => 'ClusterName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The cluster name.', 'type' => 'string', 'required' => false, 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'example' => 'xx-test-1107', 'title' => ''], ], [ - 'name' => 'WorkflowId', + 'name' => 'IpWhitelist', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['type' => 'string', 'example' => '192.168.1.0/24', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'WorkflowExecutionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique request identifier, used for troubleshooting.', 'type' => 'string', 'example' => 'EEF9AF15-AEEF-5E59-BF7B-BCBB119DC53F', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call succeeded.'."\n" + ."\n" + .'- **true**: The call succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update cluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCluster'], + ], ], - '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"}]', + '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"}]', ], - 'OperateStopWorkflowExecution' => [ - 'summary' => '停止正在运行的工作流实例', + 'UpdateContact' => [ + 'summary' => '', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14841,915 +10472,421 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227436', - 'abilityTreeNodes' => [ - 'FEATUREmse4EL0AA', - ], + 'abilityTreeNodes' => ['FEATUREmseFDWH5S'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'ContactName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-a1804a3226d', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'Tom', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => '渠道大类（可选，传入则更新）', 'type' => 'string', - 'required' => true, - 'example' => 'test-app', + 'required' => false, + 'enum' => ['IM', 'WEBHOOK', 'SMS'], + 'example' => 'IM', + 'title' => '', ], ], [ - 'name' => 'WorkflowExecutionId', + 'name' => 'Config', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => '渠道参数配置 JSON 字符串（可选，传入则更新）', 'type' => 'string', 'required' => false, 'example' => '{"channels":[{"channelType":"dingtalk","clientId":"xxx","clientSecret":"xxx","targetType":"group","targetId":"xxx","robotCode":"xxx"}]}', 'title' => ''], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => ['description' => '是否启用（true/false，可选）', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter check error', - ], + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'not support query script history, please upgrade engine version to 2.2.2+', 'title' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'example' => 'F131C3E0-3FAA-5FA4-A6F3-E974D69EF3C5', 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '更新通知联系人', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0DE9C33-992A-580B-89C4-B609A292748D\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"Parameter check error\\"\\n}","type":"json"}]', + '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"}]', ], - 'ListCalendars' => [ - 'summary' => '查询日历', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDatasource' => [ + '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, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREmse8UT78G'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Cluster ID. ', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'CalendarName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'workday', - ], + 'name' => 'DatasourceId', + 'in' => 'formData', + 'schema' => ['description' => 'DataSource ID, which can be obtained by calling the ListDatasources API. ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Year', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2024', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'Datasource Name ', 'type' => 'string', 'required' => false, 'example' => '账单拉取-支付宝团购', 'title' => ''], ], [ - 'name' => 'FetchCalendarDetail', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'Data source description ', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'None'], ], [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '20', - ], + 'name' => 'ConnectionParams', + 'in' => 'formData', + 'schema' => ['description' => 'Data source connection parameters ', 'type' => 'string', 'required' => false, 'example' => '{"host":"rm-bp1f03mxxxxx.mysql.rds.aliyuncs.com","port":3306,"userName":"test01","database":"test01","other":{"useSSL":"false"}}', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], + 'name' => 'Password', + 'in' => 'formData', + 'schema' => ['description' => 'Database password ', 'type' => 'string', 'required' => false, 'example' => '2F9e9@a69c!e18b569c8', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response ', + 'title' => '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' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => 'Id of the request ', 'title' => 'Id of the request ', 'type' => 'string', 'example' => 'BAC1ADB5-EEB5-5834-93D8-522E067AF8D9'], + 'Code' => ['description' => 'Response code ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message. ', 'type' => 'string', 'example' => 'Parameter format error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. '."\n" + .'- true: The invocation succeeded. '."\n" + .'- false: The invocation failed. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update data source ', + 'summary' => 'Update data source ', + '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"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BAC1ADB5-EEB5-5834-93D8-522E067AF8D9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"Parameter format error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetWorkflowDAGPreview' => [ - 'summary' => '获取工作流的DAG信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateExecutorGroup' => [ + 'summary' => '', + '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' => ['FEATUREmse09FNQO'], ], 'parameters' => [ [ 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'deprecated' => true, 'required' => true, 'description' => '', 'example' => '110176', 'title' => ''], ], [ - 'name' => 'WorkflowId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'group1', 'title' => ''], ], [ - 'name' => 'DagVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'v1', - ], + 'name' => 'WorkerType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'openclaw', 'title' => ''], + ], + [ + 'name' => 'Protocol', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'openai', 'title' => ''], + ], + [ + 'name' => 'Network', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'public', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'APP', 'title' => ''], + ], + [ + 'name' => 'ApiKey', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'K4KWGINZVY9JwcZT0/vpSg==', 'title' => ''], + ], + [ + 'name' => 'Workers', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => '[{"address":"http://47.111.188.191:18789"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263'], + 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'example' => 'Parameter check error'."\n", 'title' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Nodes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'job1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'settle-job', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'JobType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'script_shell', - ], - 'Coordinate' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'X' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '50', - ], - 'Y' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Target' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - ], - ], - ], + 'WorkerId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => 'ins-95mfvqrtg6fkijt1uko000', 'title' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'example' => 'myWorkflow', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'example' => 'my first workflow', 'title' => ''], + 'WorkerType' => ['type' => 'string', 'description' => '', 'example' => 'k8s_service', 'title' => ''], + 'Workers' => ['type' => 'string', 'description' => '', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], + 'AuthType' => ['type' => 'string', 'description' => '', 'example' => 'EDIT', 'title' => ''], + 'Protocol' => ['type' => 'string', 'description' => '', 'example' => 'TCP', 'title' => ''], + 'Network' => ['type' => 'string', 'description' => '', 'example' => '{\\"OfficeSiteId\\":\\"cn-hangzhou+dir-8801187585\\",\\"VSwitchIds\\":[null]}', 'title' => ''], + 'FailedService' => ['type' => 'string', 'description' => '', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], - ], - ], - '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"}]', + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], + ], + ], + '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 \\"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"}]', ], - 'ListWorkflowExecutions' => [ - 'summary' => '获取流程实例列表', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateExecutors' => [ + 'summary' => 'Updates the configuration of one or more Executors.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The Cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d', 'title' => ''], ], [ 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], - ], - [ - 'name' => 'WorkflowId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'WorkflowName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myWorkflow', - ], - ], - [ - 'name' => 'WorkflowExecutionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', + 'name' => 'WorkerType', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The Worker type.', 'type' => 'string', 'required' => false, - 'example' => '2025-10-27 02:15:00', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2025-10-13 16:00:00', - ], - ], - [ - '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' => '10', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'enum' => ['xxljob', 'dify_workflow', 'http_domain', 'k8s_service'], + 'example' => 'k8s_service', + 'title' => '', ], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], + 'name' => 'Workers', + 'in' => 'formData', + 'schema' => ['description' => 'A JSON-formatted string that contains a list of Workers.', 'type' => 'string', 'required' => false, 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The Request ID.', 'type' => 'string', 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C'], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '-', + 'description' => '- The returned data.', 'type' => 'object', 'properties' => [ - 'Records' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'WorkflowExecutionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'WorkflowId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '1827811800526000', - ], - 'Status' => [ - 'description' => '', - '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', - ], + 'WorkId' => ['description' => 'The Worker ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AppGroupId' => ['description' => 'The Application Group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'."\n", 'title' => ''], + 'AppType' => ['description' => 'The Application type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WorkerType' => ['description' => 'The Worker type.', 'type' => 'string', 'example' => 'k8s_service', 'title' => ''], + 'Workers' => ['description' => 'A JSON-formatted string that contains a list of Workers.', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], + 'FailedService' => ['description' => 'The Kubernetes services that failed to import.', 'type' => 'string', 'example' => '[{"cluster":"xxxxx","namespace":"xxxxx","service":"xxxxx"}]', 'title' => ''], ], - ], - 'MaxResults' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Update executor', + 'description' => '# Add the enhancement plugin'."\n" + ."\n" + .'Add the enhancement plugin to the `pom.xml` file to extend the capabilities of the Executor.'."\n" + ."\n" + .'**Note**: Place this plugin **above** the `xxl-job-core` dependency in the pom.xml file.'."\n" + ."\n" + .'**For more information, see the** [Plugin Version Description Document](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"}]', ], - 'DeleteWorkflow' => [ - 'summary' => '删除工作流', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateJob' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15758,648 +10895,509 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227449', - 'abilityTreeNodes' => [ - 'FEATUREmsePN2NBR', - ], + 'abilityTreeCode' => '227432', + 'abilityTreeNodes' => ['FEATUREmseCPRKIU'], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'WorkflowId', + 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'title' => '工作流ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The node ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '74', 'title' => ''], ], [ - 'name' => 'DeleteJobs', + 'name' => 'Name', 'in' => 'formData', - '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' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'schema' => ['description' => 'The node name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 200, 'example' => 'test-job'."\n", 'title' => ''], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The node description.', 'type' => 'string', 'required' => false, 'maxLength' => 300, 'example' => 'test'."\n", 'title' => ''], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + 'name' => 'RouteStrategy', + 'in' => 'formData', + 'schema' => ['description' => 'The routing policy. Valid values:'."\n" + ."\n" + .'- 1: round robin'."\n" + .'- 2: random'."\n" + .'- 3: first'."\n" + .'- 4: last'."\n" + .'- 5: least frequently used'."\n" + .'- 6: least recently used'."\n" + .'- 7: consistent hashing'."\n" + .'- 8: shard broadcast', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'maximum' => '9', 'minimum' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => ['description' => 'The node parameters.', 'type' => 'string', 'required' => false, 'maxLength' => 2000, 'example' => 'test'."\n", 'title' => ''], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + 'name' => 'MaxConcurrency', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of concurrent instances of the node.'."\n" + .'>The maximum number of instances that can run at the same time for the same node. A value of 1 indicates that repeated execution is not allowed. If the concurrency limit is exceeded, the current scheduling is skipped.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + [ + 'name' => 'MaxAttempt', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of retry attempts upon node failure.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', '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}","type":"json"}]', - ], - 'ListDatasources' => [ - 'summary' => '获取数据源列表', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AttemptInterval', + 'in' => 'formData', + 'schema' => ['description' => 'The retry interval upon node failure.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmse8UT78G', + [ + 'name' => 'JobHandler', + 'in' => 'formData', + 'schema' => ['description' => 'The JobHandler name.', 'type' => 'string', 'required' => false, 'maxLength' => 200, 'example' => 'testJobVoidHandler'."\n", 'title' => ''], ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'ClusterId', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'name' => 'Script', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The script for non-BEAN nodes. Use this field to configure the script.', 'type' => 'string', 'example' => 'echo "hello world"', 'required' => false], ], [ - 'name' => 'PageNum', - 'in' => 'query', + 'name' => 'TimeType', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The time type. Valid values:'."\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, + 'enum' => ['-1', '1', '2', '3', '5', '100'], 'example' => '1', - 'default' => '1', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'TimeExpression', + 'in' => 'formData', + 'schema' => ['description' => 'The time expression. Set the time expression based on the selected time type.'."\n" + ."\n" + .'- none: No value is required.'."\n" + .'- cron: Specify a standard cron expression. Online verification is supported.'."\n" + .'- api: No value is required.'."\n" + .'- fixed_rate: Specify a fixed frequency value in seconds. For example, 30 indicates that the node is triggered every 30 seconds.'."\n" + .'- one_time: Specify a scheduling time in the yyyy-MM-dd HH:mm:ss format or a timestamp in milliseconds. For example, "2022-10-10 10:10:00".', 'type' => 'string', 'required' => false, 'example' => '0 0 4 ? * Mon/1'."\n", 'title' => ''], + ], + [ + 'name' => 'Calendar', + 'in' => 'formData', + 'schema' => ['description' => 'The custom calendar.', 'type' => 'string', 'required' => false, 'example' => 'workday', 'title' => ''], + ], + [ + 'name' => 'XAttrs', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'example' => ' {"reponseMode":"streaming"}', 'description' => '', 'title' => ''], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => ['description' => 'The execution priority of the node. Valid values:'."\n" + ."\n" + .'- 1: low'."\n" + .'- 5: medium'."\n" + .'- 10: high'."\n" + .'- 15: very high', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'StartTimeType', + 'in' => 'formData', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The start time type.', + 'type' => 'string', + 'example' => '1', + 'enum' => ['1', '2', '3', '4'], 'required' => false, - 'example' => '10', - 'default' => '10', ], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The scheduling start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1716902187', 'title' => ''], + ], + [ + 'name' => 'Timezone', + 'in' => 'formData', + 'schema' => ['description' => 'The time zone.'."\n" + .'> By default, the time zone of the SchedulerX server is used.', 'type' => 'string', 'required' => false, 'example' => 'Hongkong', 'title' => ''], + ], + [ + 'name' => 'NoticeConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The notification configuration.', + 'type' => 'object', + 'properties' => [ + 'TimeoutEnable' => ['description' => 'Specifies whether to enable timeout alerting. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Timeout' => ['description' => 'The node execution timeout period, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90', 'title' => ''], + 'TimeoutKillEnable' => ['description' => 'Specifies whether to enable the timeout termination switch for the current trigger. Valid values:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + .'- **false**: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'SuccessNotice' => ['description' => 'Specifies whether to enable the success notification switch. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'FailEnable' => ['description' => 'Specifies whether to enable the failure alerting switch. Valid values:'."\n" + ."\n" + .'- **true**: Enabled.'."\n" + .'- **false**: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'FailLimitTimes' => ['description' => 'The number of consecutive failures.'."\n" + .'> An alert is sent only when the number of consecutive failures exceeds the configured value.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => 'true', 'title' => ''], + 'MissWorkerEnable' => ['description' => 'Specifies whether to enable the no-available-machine alerting switch. Valid values:'."\n" + .'- **true**: Enabled.'."\n" + .'- **false**: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'SendChannel' => ['description' => 'The notification channel. Valid values:'."\n" + .' - sms: text message'."\n" + .' - phone: phone call'."\n" + .'- mail: email'."\n" + .'- webhook: webhook'."\n" + .'> Separate multiple notification channels with commas.', 'type' => 'string', 'example' => 'webhook,sms,mail,phone'."\n", 'required' => false, 'title' => ''], + 'EndEarlyEnable' => ['title' => '', 'type' => 'boolean', 'default' => 'false', 'description' => '', 'required' => false, 'example' => ''], + 'EndEarly' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'description' => '', 'required' => false], + ], 'required' => false, 'example' => '', ], ], [ - 'name' => 'Type', - 'in' => 'query', + 'name' => 'NoticeContacts', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The notification contact configuration.', + 'type' => 'array', + 'items' => [ + 'description' => '-', + 'type' => 'object', + 'properties' => [ + 'ContactType' => [ + 'description' => 'The contact type. '."\n" + .'>Default configurations: 1.', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['1', '2', '3'], + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'Name' => ['description' => 'The contact name.', 'type' => 'string', 'required' => false, 'example' => 'xiaoming', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'REDIS', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResults', - 'in' => 'query', + 'name' => 'ExecutorBlockStrategy', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The client blocking strategy. Valid values:'."\n" + .'- 1: serial execution on a single machine'."\n" + .'- 2: ignore subsequent scheduling'."\n" + .'- 3: override previous scheduling', 'type' => 'integer', 'format' => 'int32', + 'example' => '1', + 'enum' => ['1', '2', '3'], 'required' => false, - 'example' => '10', + 'title' => '', ], ], [ - 'name' => 'NextToken', - 'in' => 'query', + 'name' => 'ChildJobId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The child node IDs, separated by commas.', 'type' => 'string', 'example' => '1,2', 'required' => false], + ], + [ + 'name' => 'Weight', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The node weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + ], + [ + 'name' => 'DependentStrategy', + 'in' => 'formData', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The dependency strategy.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8'], 'required' => false, - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', ], ], ], '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Records' => [ - 'description' => '-', - 'type' => 'array', - 'items' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'DatasourceId' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eCKqVlS5FKF5EWGGOo8EgQ==', - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '3808cf26-dde2-4286-8503-b0a2cd4065a7', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Update a node', + 'summary' => 'Updates node information.', + 'changeSet' => [ + ['createdAt' => '2025-12-24T08:56:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-22T07:53:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-04T09:10:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-24T09:10:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-09T06:28:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-17T09:51:37.000Z', 'description' => 'Request parameters changed'], ], - '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"}]', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'Cluster ID. ', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'AppName ', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - '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' => 'Job execution ID. ', 'type' => 'string', 'required' => true, 'example' => '1310630367761285120', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'ScheduleTime', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***', - ], + 'schema' => ['description' => 'Schedule time ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2023-10-01 12:00:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response ', + 'title' => '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'Id of the request ', 'title' => 'Id of the request ', 'type' => 'string', 'example' => '27B1345D-5F71-5972-8E4C-AABA6C6232F0'], + 'Code' => ['description' => 'Response code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'error message ', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. '."\n" + .'- true: The invocation succeeded. '."\n" + .'- false: Failed to Invocate. ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update task instance ', + 'summary' => 'Update task instance ', + '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"}]', + '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"}]', + 'translator' => 'machine', ], - 'DeleteDatasource' => [ - 'summary' => '删除数据源', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateJobScript' => [ + 'summary' => 'Updates a job script.', + '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'DatasourceId', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '195', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'ScriptContent', + 'in' => 'formData', + 'schema' => ['description' => 'The script content.', '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', 'title' => ''], + ], + [ + 'name' => 'VersionDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the script version.', 'type' => 'string', 'required' => true, 'example' => 'init version', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '74', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'not support update script, please upgrade engine version to 2.2.2+', 'title' => ''], + 'RequestId' => ['description' => 'The Request ID. Alibaba Cloud generates this unique identifier for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '29ED6209-5DE6-5E1D-89B0-B7B1D823A1BF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Update Job Execution Script', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'UpdateDatasource' => [ - 'summary' => '更新数据源', + 'UpdateWorkflow' => [ 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16411,153 +11409,134 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREmse8UT78G', - ], + 'abilityTreeCode' => '227447', + 'abilityTreeNodes' => ['FEATUREmseWTWX7C'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-d6a5243b6fa', 'title' => ''], ], [ - 'name' => 'DatasourceId', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-app', 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', 'title' => ''], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => false, 'example' => 'myWorkflow', 'maxLength' => 32, 'minLength' => 6, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'None', - ], + 'schema' => ['description' => 'The workflow description.', 'type' => 'string', 'required' => false, 'example' => 'my first workflow', 'maxLength' => 64, 'title' => ''], ], [ - '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' => 'The scheduling type. Valid values:'."\n" + ."\n" + .'- `-1` (none): The workflow is not scheduled and must be triggered on demand.'."\n" + ."\n" + .'- `1` (cron): The workflow runs based on the cron expression in the `TimeExpression` parameter.'."\n" + ."\n" + .'- `100` (api): The workflow is triggered by an API call.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'TimeExpression', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2F9e9@a69c!e18b569c8', - ], + 'schema' => ['description' => 'The cron expression for the schedule. This parameter is required only when `TimeType` is set to `1` (cron).'."\n" + ."\n" + .'- If `TimeType` is `-1` (none), this parameter is not required.'."\n" + ."\n" + .'- If `TimeType` is `1` (cron), specify a standard cron expression.'."\n" + ."\n" + .'- If `TimeType` is `100` (api), this parameter is not required.', 'type' => 'string', 'required' => false, 'example' => '0 0/10 * * * ?', 'title' => ''], + ], + [ + 'name' => 'Timezone', + 'in' => 'formData', + 'schema' => ['description' => 'The time zone for the schedule.'."\n" + ."\n" + .'> Defaults to the time zone of the SchedulerX server.', 'type' => 'string', 'required' => false, 'example' => 'GMT+8', 'title' => ''], + ], + [ + 'name' => 'Calendar', + 'in' => 'formData', + 'schema' => ['description' => 'The name of a custom calendar to exclude specific dates from the schedule.', 'type' => 'string', 'required' => false, 'example' => 'workday', 'title' => ''], + ], + [ + 'name' => 'MaxConcurrency', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum concurrency for the workflow.'."\n" + ."\n" + .'> The maximum number of concurrent instances that can run for the same workflow. A value of `1` prevents overlapping runs. If the number of running instances reaches this limit, subsequent scheduled runs are skipped.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'A unique token that you provide to ensure the request is idempotent. The token can be up to 64 ASCII characters long.', 'type' => 'string', 'required' => false, 'example' => 'D0DE9C33-992A-580B-89C4-B609A292748D', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID generated for the request. If you encounter an issue, provide this ID for troubleshooting.', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update pipeline', + 'summary' => 'Updates an existing workflow.', + '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"}]', + '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' => 'Updates a workflow\'s Directed Acyclic Graph (DAG), including node coordinates and edges.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16566,136 +11545,199 @@ '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' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxljob-b6ec1xxxx', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-a1804a3226d', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'JobExecutionId', + 'name' => 'WorkflowId', 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Dag', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The directed acyclic graph (DAG) of the workflow.', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'A list of nodes in the workflow.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a node.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'Coordinate' => [ + 'description' => 'The coordinates of the node.', + 'type' => 'object', + 'properties' => [ + 'X' => ['description' => 'The x-coordinate.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '50', 'title' => ''], + 'Y' => ['description' => 'The y-coordinate.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '50', 'title' => ''], + 'Width' => ['description' => 'Optional. The width of the node.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100', 'title' => ''], + 'Height' => ['description' => 'Optional. The height of the node.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Content' => ['description' => 'The logical expression of the node.', '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", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Edges' => [ + 'description' => 'A list of edges in the workflow.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an edge. The direction of the edge is from a Source to a Target.', + 'type' => 'object', + 'properties' => [ + 'Source' => ['description' => 'The job ID of the source node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + 'Target' => ['description' => 'The job ID of the target node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => '1310630367761285120', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ScheduleTime', + 'name' => 'DagVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2023-10-01 12:00:00', - ], + 'schema' => ['description' => 'The version of the DAG. To obtain this value, call the [ListDAGVersions](~~465989~~) operation.', 'type' => 'string', 'required' => false, 'example' => '1137005', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The schema of the 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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter error: content is null.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. This ID is generated by Alibaba Cloud for troubleshooting purposes.', 'type' => 'string', 'example' => 'AA3538A0-FBE6-5E31-AD88-A02C6FF0DACC', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Update the DAG information of a pipeline ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', ], - 'CreateDatasource' => [ - 'summary' => '创建数据源', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateWorkflowDAGVersion' => [ + 'summary' => 'Updates the Directed Acyclic Graph (DAG) version for a Workflow.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16704,217 +11746,221 @@ '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' => '', - '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' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'xxljob-b6ec1xxxx', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'AppName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 64, 'minLength' => 1, 'pattern' => '^[0-9a-zA-Z_-]+$', 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'ConnectionParams', + 'name' => 'WorkflowId', '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"}}'."\n", - ], + 'schema' => ['description' => 'The Workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'DagVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '***', - ], + 'schema' => ['description' => 'The Workflow DAG version.', 'type' => 'string', 'required' => true, 'example' => 'v1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Parameter error: content is null.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3835AA29-2298-5434-BC53-9CC377CDFD2C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '-', - 'type' => 'object', - 'properties' => [ - 'DatasourceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Parameter check error', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID for the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'C78E2AD2-5985-515B-BAD2-31A248AFC263', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- `true`: The call succeeded.'."\n" + ."\n" + .'- `false`: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Parameter error: %s.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Parameter error: %s.', 'description' => 'Parameter error: %s'], ], [ - [ - 'errorCode' => 'IllegalRequest', - 'errorMessage' => 'IllegalRequest: %s.', - ], + ['errorCode' => 'IllegalRequest', 'errorMessage' => 'IllegalRequest: %s.', 'description' => 'Illegal request:%s'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission to perform this operation: %s.', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission to perform this operation: %s.', 'description' => 'No permission to perform this operation: %s'], ], [ - [ - 'errorCode' => 'NotFound', - 'errorMessage' => 'Not found: %s.', - ], + ['errorCode' => 'NotFound', 'errorMessage' => 'Not found: %s.', 'description' => 'The resource does not exist: %s'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InternalError: %s.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'InternalError: %s.', 'description' => 'System Internal Error: %s'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Switch pipeline DAG version ', + '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 \\"DatasourceId\\": 1\\n }\\n}","type":"json"}]', ], ], 'endpoints' => [ + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-shenzhen.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-shenzhen.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-beijing.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-beijing.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-chengdu.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-chengdu.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-shanghai.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-shanghai.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-guangzhou.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-guangzhou.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-hongkong.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-hongkong.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'schedulerx3.cn-hangzhou.aliyuncs.com', 'endpoint' => 'schedulerx3.cn-hangzhou.aliyuncs.com', 'vpc' => 'schedulerx3-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'Illegal request:%s'], + ['code' => 'InternalError', 'message' => 'InternalError: %s.', 'http_code' => 500, 'description' => 'System Internal Error: %s'], + ['code' => 'InvalidParameter', 'message' => 'Parameter error: %s.', 'http_code' => 400, 'description' => 'Parameter error: %s'], + ['code' => 'NoPermission', 'message' => 'No permission to perform this operation: %s.', 'http_code' => 403, 'description' => 'No permission to perform this operation: %s'], + ['code' => 'NotFound', 'message' => 'Not found: %s.', 'http_code' => 404, 'description' => 'The resource does not exist: %s'], + ], + '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' => 'Response parameters changed', 'api' => 'ListApps'], + ], + 'createdAt' => '2025-12-25T03:50:53.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'schedulerx3.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateJob'], + ['description' => 'Response parameters changed', 'api' => 'GetCluster'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetLogEvent'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListJobExecutions'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListJobs'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListScheduleEvent'], + ['description' => 'Request parameters changed', 'api' => 'OperateRetryJobExecution'], + ['description' => 'Request parameters changed', 'api' => 'OperateStopJobExecution'], + ['description' => 'Request parameters changed', 'api' => 'UpdateJob'], + ], + 'createdAt' => '2025-12-24T08:56:33.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'schedulerx3.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateJob'], + ['description' => 'Response parameters changed', 'api' => 'ListJobs'], + ['description' => 'Request parameters changed', 'api' => 'UpdateJob'], + ], + 'createdAt' => '2025-03-24T09:10:22.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'schedulerx3.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateJob'], + ['description' => 'Request parameters changed', 'api' => 'UpdateJob'], + ], + 'createdAt' => '2025-01-09T06:28:39.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'schedulerx3.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateJob'], + ['description' => 'Response parameters changed', 'api' => 'ListJobs'], + ['description' => 'Request parameters changed', 'api' => 'UpdateJob'], + ], + 'createdAt' => '2024-12-17T09:52:13.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'schedulerx3.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListJobs'], + ], + 'createdAt' => '2024-11-29T02:39:20.000Z', + 'description' => '', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'schedulerx3.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'OperateRetryJobExecution'], + ['description' => 'Request parameters changed', 'api' => 'OperateStopJobExecution'], + ], + 'createdAt' => '2024-11-28T05:41:02.000Z', + 'description' => '', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'schedulerx3.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetJobExecutionProgress'], + ['description' => 'Request parameters changed', 'api' => 'GetLog'], + ['description' => 'Response parameters changed', 'api' => 'ListClusters'], + ['description' => 'Request parameters changed', 'api' => 'ListJobExecutions'], + ['description' => 'Request parameters changed', 'api' => 'ListScheduleEvent'], + ['description' => 'Request parameters changed', 'api' => 'OperateRetryJobExecution'], + ['description' => 'Request parameters changed', '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'], ], ], ]; |