{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]},"QueryScheduleTaskListResponse":{"properties":{"schedules":{"description":"任务详情","items":{"$ref":"#/definitions/ScheduleTask"},"type":"array"},"total_count":{"description":"记录总数。","example":2,"type":"integer"}},"required":["schedules","total_count"]},"ScheduleTask":{"properties":{"create_time":{"description":"任务创建时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空","example":"2018-08-06T10:41:14+0000","type":"string"},"datastore_type":{"description":"数据库类型。","example":"gaussdb-mysql","type":"string"},"end_time":{"description":"任务结束时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空","example":"2018-08-06T10:41:14+0000","type":"string"},"instance_id":{"description":"实例ID。","example":"79bc540dd4d6432784894a981fdfacfcin07","type":"string"},"instance_name":{"description":"实例名称。","example":"gauss-f821","type":"string"},"instance_status":{"description":"实例状态。\n取值:\n- 值为“createfail”,表示实例创建失败。\n- 值为“creating”,表示实例创建中。\n- 值为“normal”,表示实例正常。\n- 值为“abnormal”,表示实例异常。\n- 值为“deleted”,表示实例已删除。","example":"ACTIVE","type":"string"},"job_id":{"description":"任务ID。","example":"56d3c1138dcf4f1da73b0170700c78d0","type":"string"},"job_name":{"description":"任务名称。取值有:\n - \"CreateGaussDBforMySQLInstance\"表示创建实例。\n - \"RestoreGaussDBforMySQLNewInstance\"表示恢复新实例。\n - \"AddGaussDBforMySQLNodes\"表示添加节点。\n - \"DeleteGaussDBforMySQLNode\"表示删除节点。\n - \"RebootGaussDBforMySQLInstance\"表示重启实例。\n - \"ModifyGaussDBforMySQLPort\"表示修改实例端口。\n - \"ModifyGaussDBforMySQLSecurityGroup\"表示修改实例安全组。\n - \"ResizeGaussDBforMySQLFlavor\"表示实例规格变更。\n - \"SwitchoverGaussDBforMySQLMasterNode\"表示只读升主。\n - \"GaussDBforMySQLBindEIP\"表示绑定弹性公网IP。\n - \"GaussDBforMySQLUnbindEIP\"表示解绑弹性公网IP。\n - \"RenameGaussDBforMySQLInstance\"表示修改实例名称。\n - \"DeleteGaussDBforMySQLInstance\"表示删除实例集群。\n - \"UpgradeGaussDBforMySQLDatabaseVersion\"表示版本升级。\n - \"EnlargeGaussDBforMySQLProxy\"表示实例的数据库代理节点扩容。\n - \"ReduceGaussDBforMySQLProxy\"表示实例的数据库代理节点缩容。\n - \"OpenGaussDBforMySQLProxy\"表示开启实例的数据库代理。\n - \"CloseGaussDBforMySQLProxy\"表示关闭实例的数据库代理。\n - \"GaussdbforMySQLModifyProxyIp\"表示修改数据库代理ip。\n - \"ScaleGaussDBforMySQLProxy\"表示实例的数据库代理节点规格变更。\n - \"GaussDBforMySQLModifyInstanceMetricExtend\"表示实例秒级监控。\n - \"GaussDBforMySQLModifyInstanceDataVip\"表示修改实例数据Vip。\n - \"GaussDBforMySQLSwitchSSL\"表示切换实例SSL开关。\n - \"GaussDBforMySQLModifyProxyConsist\"表示修改代理一致性。\n - \"GaussDBforMySQLModifyProxyWeight\"表示修改代理权重。","type":"string"},"job_status":{"description":"任务执行状态。\n取值:\n- 值为“Pending”,表示延时任务,未执行。\n- 值为“Running”,表示任务正在执行。\n- 值为“Completed”,表示任务执行成功。\n- 值为“Failed”,表示任务执行失败。","example":"Completed","type":"string"},"project_id":{"description":"租户在某一region下的project ID。","example":"053f533ead80d5102f0cc012e8d468a4","type":"string"},"start_time":{"description":"任务开始时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空","example":"2018-08-06T10:41:14+0000","type":"string"},"target_config":{"description":"实例配置相关信息,比如规格等。","example":{"cpu":"2","flavor":"gaussdb.mysql.large.arm.4","mem":"8"},"type":"object"}}}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"37c46a5ca68a47ac888265e4990b5376","info_version":"v3","method":"get","name":"ListScheduleJobs","parameters":{},"paths":{"/v3/{project_id}/scheduled-jobs":{"get":{"description":"获取定时任务列表。","operationId":"ListScheduleJobs","parameters":[{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"语言。","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"租户在某一region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为1,必须为数字,不能为负数。","in":"query","name":"offset","required":false,"type":"string","x-example":"0"},{"description":"查询记录数。默认为10","in":"query","name":"limit","required":false,"type":"string","x-example":"10"},{"description":"任务执行状态。\n取值:\n- 值为“Running”,表示任务正在执行。\n- 值为“Completed”,表示任务执行成功。\n- 值为“Failed”,表示任务执行失败。\n- 值为“Pending”,表示任务未执行。","in":"query","name":"status","required":false,"type":"string","x-example":"Running"},{"description":"起始时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。","in":"query","name":"start_time","required":false,"type":"string"},{"description":"结束时间,格式为\"yyyy-mm-ddThh:mm:ssZ\"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 说明:创建时返回值为空,数据库实例创建成功后该值不为空。","in":"query","name":"end_time","required":false,"type":"string"},{"description":"任务ID。","in":"query","name":"job_id","required":false,"type":"string"},{"description":"任务调度类型。","in":"query","name":"job_name","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"schedules":[{"create_time":"2018-08-06T10:41:14+0000","datastore_type":"gaussdb-mysql","end_time":"2018-08-06T10:41:14+0000","instance_id":"79bc540dd4d6432784894a981fdfacfcin07","instance_name":"gauss-f821","instance_status":"BUILD","job_id":"56d3c1138dcf4f1da73b0170700c78d0","job_name":"VERSION_UPGRADE","job_status":"Completed","project_id":"053f533ead80d5102f0cc012e8d468a4","start_time":"2018-08-06T10:41:14+0000","target_config":{"cpu":"2","flavor":"gaussdb.mysql.xlarge.arm.4","mem":"8"}}],"total_count":1}},"schema":{"$ref":"#/definitions/QueryScheduleTaskListResponse"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"获取定时任务列表","tags":["任务中心"],"x-is-registered":"N","x-request-examples-description-1":"获取定时任务列表。","x-request-examples-url-1":"GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs?offset=1&limit=10","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取定时任务列表","tags":"任务中心","uri":null,"version":"2.0"}