{"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"]},"TaskCenterTaskListRsp":{"properties":{"jobs":{"description":"任务详情。","items":{"$ref":"#/definitions/TaskDetailInfo"},"type":"array"},"total_count":{"description":"任务总数。","type":"integer"}}},"TaskDetailInfo":{"properties":{"created_time":{"description":"任务创建时间。格式为\"yyyy-mm-ddThh:mm:ssZ\"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。","type":"string"},"ended_time":{"description":"任务结束时间。格式为\"yyyy-mm-ddThh:mm:ssZ\"。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。","type":"string"},"fail_reason":{"description":"任务失败原因。","type":"string"},"instance_id":{"description":"实例ID。","type":"string"},"instance_name":{"description":"实例名称。","type":"string"},"instance_status":{"description":"实例状态。\n取值:\n- 值为“createfail”,表示实例创建失败。\n- 值为“creating”,表示实例创建中。\n- 值为“normal”,表示实例正常。\n- 值为“abnormal”,表示实例异常。\n- 值为“deleted”,表示实例已删除。","type":"string"},"job_id":{"description":"任务ID。","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 - \"OpenGaussDBforMySQLProxy\"表示开启实例的数据库代理。\n - \"CloseGaussDBforMySQLProxy\"表示关闭实例的数据库代理。\n - \"GaussdbforMySQLModifyProxyIp\"表示修改数据库代理ip。\n - \"ScaleGaussDBforMySQLProxy\"表示实例的数据库代理节点规格变更。\n - \"GaussDBforMySQLModifyInstanceMetricExtend\"表示实例秒级监控。\n - \"GaussDBforMySQLModifyInstanceDataVip\"表示修改实例数据Vip。\n - \"GaussDBforMySQLSwitchSSL\"表示切换实例SSL开关。\n - \"GaussDBforMySQLModifyProxyConsist\"表示修改代理一致性。\n - \"GaussDBforMySQLModifyProxyWeight\"表示修改代理权重。","type":"string"},"order_id":{"description":"订单ID。","type":"string"},"process":{"description":"任务进度。","type":"string"},"status":{"description":"任务执行状态。\n取值:\n- 值为“Pending”,表示延时任务,未执行。\n- 值为“Running”,表示任务正在执行。\n- 值为“Completed”,表示任务执行成功。\n- 值为“Failed”,表示任务执行失败。","type":"string"}}}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"5abfbc9c36b14aadb2fd3420067035bf","info_version":"v3","method":"get","name":"ListImmediateJobs","parameters":{},"paths":{"/v3/{project_id}/immediate-jobs":{"get":{"description":"获取即时任务列表。","operationId":"ListImmediateJobs","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":"任务执行状态。\n取值:\n- 值为“Running”,表示任务正在执行。\n- 值为“Completed”,表示任务执行成功。\n- 值为“Failed”,表示任务执行失败。\n- 值为“Pending”,表示任务未执行。","in":"query","name":"status","required":false,"type":"string"},{"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 - \"OpenGaussDBforMySQLProxy\"表示开启实例的数据库代理。\n - \"CloseGaussDBforMySQLProxy\"表示关闭实例的数据库代理。\n - \"GaussdbforMySQLModifyProxyIp\"表示修改数据库代理ip。\n - \"ScaleGaussDBforMySQLProxy\"表示实例的数据库代理节点规格变更。\n - \"GaussDBforMySQLModifyInstanceMetricExtend\"表示实例秒级监控。\n - \"GaussDBforMySQLModifyInstanceDataVip\"表示修改实例数据Vip。\n - \"GaussDBforMySQLSwitchSSL\"表示切换实例SSL开关。\n - \"GaussDBforMySQLModifyProxyConsist\"表示修改代理一致性。\n - \"GaussDBforMySQLModifyProxyWeight\"表示修改代理权重。","in":"query","name":"job_name","required":false,"type":"string"},{"description":"任务ID。","in":"query","name":"job_id","required":false,"type":"string"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为1,必须为数字,不能为负数。","in":"query","name":"offset","required":false,"type":"string"},{"description":"查询记录数。默认为10,取值为10、20、50。","in":"query","name":"limit","required":false,"type":"string"},{"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"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"jobs":[{"created_time":"2018-08-06T10:41:14+0000","ended_time":"2018-08-06T12:41:14+0000","fail_reason":"Single task exception.","instance_id":"ede953923f06448d9be8686ef0c1378ein07","instance_name":"gauss-1234","instance_status":"deleted","job_id":"7155730b-a60b-4dc0-9f89-3f55897f29d6","job_name":"CloseGaussDBforMySQLProxy","order_id":"","process":"","status":"Completed"}],"total_count":1}},"schema":{"$ref":"#/definitions/TaskCenterTaskListRsp"}},"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/immediate-jobs","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取即时任务列表","tags":"任务中心","uri":null,"version":"2.0"}