获取定时任务列表
URI
GET /v3/{project_id}/scheduled-jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
String |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为整数,不能为负数。 取值范围: ≥0。 默认取值: 0。 |
limit |
否 |
String |
参数解释: 查询记录数。 约束限制: 必须为整数,不能为负数。 取值范围: 1-100。 默认取值: 100。 |
status |
否 |
String |
参数解释: 任务执行状态。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
start_time |
否 |
String |
参数解释: 起始时间。 约束限制: 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 默认取值: 不涉及。 |
end_time |
否 |
String |
参数解释: 结束时间。 约束限制: 格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 默认取值: 不涉及。 |
job_id |
否 |
String |
参数解释: 任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
job_name |
否 |
String |
参数解释: 任务调度类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
schedules |
Array of ScheduleTask objects |
参数解释: 任务详情。 |
total_count |
Integer |
参数解释: 记录总数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
instance_id |
String |
参数解释: 实例ID,严格匹配UUID规则。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 |
instance_name |
String |
参数解释: 实例名称。 取值范围: 实例ID对应的实例名称。 |
instance_status |
String |
参数解释: 实例状态。 取值范围: |
project_id |
String |
参数解释: 租户在某一Region下的project ID。 取值范围: 实例所在的项目ID。 |
job_name |
String |
参数解释: 任务名称。 取值范围: |
create_time |
String |
参数解释: 任务创建时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 |
start_time |
String |
参数解释: 任务开始时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 |
end_time |
String |
参数解释: 任务结束时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 取值范围: 不涉及。 |
job_status |
String |
参数解释: 任务执行状态。 取值范围: |
datastore_type |
String |
参数解释: 数据库类型。 取值范围: 不涉及。 |
target_config |
Object |
参数解释: 实例配置相关信息,比如规格等。 取值范围: 不涉及。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
获取定时任务列表。
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs?offset=1&limit=10
响应示例
状态码: 200
Success.
{ "schedules" : [ { "job_id" : "56d3c1138dcf4f1da73b0170700c78d0", "instance_id" : "79bc540dd4d6432784894a981fdfacfcin07", "instance_name" : "gauss-f821", "instance_status" : "BUILD", "project_id" : "053f533ead80d5102f0cc012e8d468a4", "job_name" : "UpgradeGaussDBforMySQLDatabaseVersion", "create_time" : "2018-08-06T10:41:14+0000", "start_time" : "2018-08-06T10:41:14+0000", "end_time" : "2018-08-06T10:41:14+0000", "job_status" : "Completed", "datastore_type" : "gaussdb-mysql", "target_config" : { "flavor" : "gaussdb.mysql.xlarge.arm.4", "mem" : "16", "cpu" : "4" } } ], "total_count" : 1 }
状态码
请参见状态码。
错误码
请参见错误码。