ScheduledTask 接口文档

1. 通用返回码说明

类型CODE说明
InternalServerErrorInternalServerError服务器内部错误
MissingParameterMissingParameter参数 %s 缺失
InvalidFormatInvalidFormat参数 %s 的格式非法
AlreadyExistAlreadyExist%s 已存在
CanNotFoundCanNotFound%s 不存在
QuotaInsufficientQuotaInsufficient%s 配额不足

2. 接口说明

2.1 创建定时任务

  • method && URL
METHODURL
POST/ncs?Version=2017-11-16&Action=CreateScheduledTask
  • 输入参数说明

示例

{
    "ClusterId": 1,
    "ScheduledTaskName": "ncetask",
    "Description": "this is ncetask",
    "ScheduledAction": "Scale",
    "TargetParams": {
        "DesiredReplicas": "3"
    },
    "TargetType": "Deployment",
    "TargetId": "12345",
    "Scope": "Namespace",
    "NamespaceId": "12345",
    "CronTime": "0 0 12 * * ",
    "TaskEnabled": "true"
}
  • 说明
参数说明类型备注
ClusterId集群id。 不填就是默认集群，系统做初始化默认集群。long非必选
ScheduledTaskName定时任务的显示名称，2-40 个英文或中文字符，以数字、大小字母或中文开头，可包含数字，”_”、”-“ 或”.” 。同一用户账号同一地域内唯一。string必选
Description定时任务的描述信息。0-100 个英文或中文字符。string非必选
ScheduledAction定时任务触发时需要执行的操作。 取值范围：一期只支持Scalestring必选
TargetParams目标action的参数。 当action=Scale时：为{DesiredReplicas: xx}object必选
TargetType定时任务操作的对象。对象类型, 一期只支持Deploymentstring必选
TargetId定时任务操作的对象。对象的idstring必选
Scope表示任务关联的资源是全局的还是namespace级别的.取值范围:Global,Namespace，一期都需指定Namespace级别string必选
NamespaceId任务关联的资源所属空间Id，一期必选long必选
CronTime采取Linux-Crontab的Cron表达式，不支持秒级，不能填写自创建或修改当天起90日后的时间。详情参考Cron wiki : https://zh.wikipedia.org/wiki/Cronstring必选
TaskEnabled是否启动定时任务.true为启动，false为停止boolean非必选

TargetParams对象格式为:

参数类型说明备注是否必填
DesiredReplicasstring当ScheduledAction =Scale时必填。只检查用户额度配额， 不检查当前配额否
  • 返回

示例

{
 "ScheduledTaskId":123456
}
参数说明类型
ScheduledTaskId定时任务idlong

2.2 删除定时任务

  • method && URL
METHODURL
GET/ncs?Version=2017-11-16&Action=DeleteScheduledTask
  • 输入参数说明

示例

&ScheduledTaskId=45678
参数说明类型备注
ScheduledTaskId定时任务idlong必选
  • 返回

无

2.3 查询定时任务列表

  • method && URL
METHODURL
GET/ncs?Version=2017-11-16&Action=DescribeScheduledTasks
  • 输入参数说明

示例

&ScheduledTaskIds=1,2,3&ScheduledTaskNames=nce0,nce1&ScheduledActions=Scale&Limit=1&Offset=2&Scope=Namespace&NamespaceId=123&ClusterId=1
参数说明类型备注
ScheduledTaskIds定时任务Id，最多可以输入20个。查询结果会忽略失效的定时任务ID，并且不报错。long array非必选
ScheduledTaskNames定时任务的显示名称，最多可以输入20个。查询结果会忽略失效的定时任务名称，并且不报错。string array非必选
ScheduledActions定时任务触发时需要执行的操作，最多可以输入20个。查询结果会忽略失效的操作，并且不报错。string array非必选
Limit查询数量大于0整数，默认20int非必选
Offset列表偏移大等于0整数，默认0int非必选
Scope表示任务关联的资源是全局的还是namespace级别的，取值范围:Global,Namespace，一期都需指定Namespace级别string必选
NamespaceId表示任务关联的资源所属Namespace的id,不填则返回该与Scope资源关联的所有任务long非必选
ClusterId表示集群id，不填表示返回当前租户所有集群下的任务long非必选
  • 返回

示例

{
    "TotalCount": 1,
    "ScheduledTasks": [
        {
            "CreateAt": "2018-07-23T06:15:52Z",
            "CronTime": "0 0 12 * * ",
            "Description": "thisistest",
            "NextExecuteAt": "2018-08-11T16:00:00Z",
            "ScheduledAction": "Scale",
            "ScheduledTaskId": 8,
            "ScheduledTaskName": "1好",
            "TargetId": "7092",
            "TargetParams": {
                "DesiredReplicas": "1"
            },
            "TargetExists": true,
            "TargetType": "Deployment",
            "TaskEnabled": true,
            "UpdateAt": "2018-07-23T06:15:52Z"
        }
    ]
}
参数说明类型备注
TotalCount服务总数int
ScheduledTasks服务列表，参见services参数详细说明array

ScheduledTasks参数详细说明：

参数说明类型备注
ScheduledTaskId定时任务idlong
ScheduledTaskName定时任务名string
Description描述信息string
TargetId目标对象idString
TargetType目标对象类型string
ScheduledAction定时任务触发时需要执行的操作string
TargetParams目标action的参数object
TaskEnabled任务是否启动boolean
CronTime定时任务触发时间,cron表达式string
CreateAt定时任务创建时间stringISO格式
UpdateAt定时任务上次修改时间stringISO格式
NextExecuteAt定时任务下次执行时间stringISO格式
TargetExists表示定时任务关联的资源对象是否存在，用于提示用户(临时解决方案)boolean

TargetParams参数详细说明：

参数说明类型备注
DesiredReplicas目标副本数stringaction为scale时对应该值

2.4 修改定时任务

  • method && URL
METHODURL
POST/ncs?Version=2017-11-16&Action=ModifyScheduledTask
  • 输入参数说明

示例

{
    "ClusterId": 1,
    "ScheduledTaskId": 12345,
    "ScheduledTaskName": "ncetask",
    "Description": "this is ncetask",
    "ScheduledAction": "Scale",
    "TargetParams": {
        "DesiredReplicas": "3"
    },
    "TargetType": "Deployment",
    "TargetId": "12345",
    "Scope": "Namespace",
    "NamespaceId": "12345",
    "CronTime": "0 0 12 * * ",
    "TaskEnabled": "true"
}

说明：

参数说明类型备注
ClusterId集群id。 不填就是默认集群，系统做初始化默认集群。long非必选
ScheduledTaskId定时任务Id。long必选
ScheduledTaskName定时任务的显示名称，2-40 个英文或中文字符，以数字、大小字母或中文开头，可包含数字，”_”、”-“ 或”.” 。同一用户账号同一地域内唯一。string必选
Description定时任务的描述信息。0-100 个英文或中文字符。string非必选
ScheduledAction定时任务触发时需要执行的操作。 取值范围：一期只支持Scalestring必选
TargetParams目标action的参数。 当action=Scale时：为{DesiredReplicas: xx}。object必选
TargetType定时任务操作的对象。对象类型, 一期只支持Deploymentstring必选
TargetId定时任务操作的对象。对象的idstring必选
Scope表示任务关联的资源是全局的还是namespace级别的.取值范围:Global,Namespace，一期都需指定Namespace级别string必选
NamespaceId任务关联的资源所属空间Id，一期必选long必选
CronTime采取Linux-Crontab的Cron表达式，不支持秒级，不能填写自创建或修改当天起90日后的时间。详情参考Cron wiki : https://zh.wikipedia.org/wiki/Cronstring必选
TaskEnabled是否启动定时任务.true为启动，false为停止。boolean非必选

备注：除去任务id不可以修改，其他字段都可以修改

TargetParams对象格式为:

参数说明备注是否必填
DesiredReplicasstring当ScheduledAction =Scale时必填。否
  • 返回

无