更新时间:2023-10-23 GMT+08:00

获取定时任务列表

功能介绍

获取定时任务列表。

URI

GET /v3/{project_id}/scheduled-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

String

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0,必须为数字,不能为负数。

limit

String

查询记录数。默认为10。

status

String

任务执行状态。 :

取值范围:

  • Running:任务正在执行。
  • Completed:任务执行成功。
  • Failed:任务执行失败。
  • Pending:任务未执行。

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

任务调度类型。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

schedules

Array of ScheduleTask objects

任务详情

total_count

Integer

记录总数。

表5 ScheduleTask

参数

参数类型

描述

job_id

String

任务ID。

instance_id

String

实例ID。

instance_name

String

实例名称。

instance_status

String

实例状态。

取值范围:

  • createfail:实例创建失败。
  • creating:实例创建中。
  • normal:实例正常。
  • abnormal:实例异常。
  • deleted:实例已删除。

project_id

String

租户在某一Region下的project ID。

job_name

String

任务名称。

取值范围:

  • CreateGaussDBforMySQLInstance:创建实例。
  • RestoreGaussDBforMySQLNewInstance:恢复新实例。
  • AddGaussDBforMySQLNodes:添加节点。
  • DeleteGaussDBforMySQLNode:删除节点。
  • RebootGaussDBforMySQLInstance:重启实例。
  • ModifyGaussDBforMySQLPort:修改实例端口。
  • ModifyGaussDBforMySQLSecurityGroup:修改实例安全组。
  • ResizeGaussDBforMySQLFlavor:实例规格变更。
  • SwitchoverGaussDBforMySQLMasterNode:只读升主。
  • GaussDBforMySQLBindEIP:绑定弹性公网IP。
  • GaussDBforMySQLUnbindEIP:解绑弹性公网IP。
  • RenameGaussDBforMySQLInstance:修改实例名称。
  • DeleteGaussDBforMySQLInstance:删除实例集群。
  • UpgradeGaussDBforMySQLDatabaseVersion:版本升级。
  • EnlargeGaussDBforMySQLProxy:实例的数据库代理节点扩容。
  • OpenGaussDBforMySQLProxy:开启实例的数据库代理。
  • CloseGaussDBforMySQLProxy:关闭实例的数据库代理。
  • GaussdbforMySQLModifyProxyIp:修改数据库代理IP。
  • ScaleGaussDBforMySQLProxy:实例的数据库代理节点规格变更。
  • GaussDBforMySQLModifyInstanceMetricExtend:实例秒级监控。
  • GaussDBforMySQLModifyInstanceDataVip:修改实例数据Vip。
  • GaussDBforMySQLSwitchSSL:切换实例SSL开关。
  • GaussDBforMySQLModifyProxyConsist:修改代理一致性。
  • GaussDBforMySQLModifyProxyWeight:修改代理权重。

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

任务执行状态。

取值范围:

  • Pending:延时任务未执行。
  • Running:任务正在执行。
  • Completed:任务执行成功。
  • Failed:任务执行失败。

datastore_type

String

数据库类型。

target_config

Object

实例配置相关信息,比如规格等。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

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
}

状态码

请参见状态码

错误码

请参见错误码