huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20251128

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"NoSqlQueryScheduleJobsResponseBody":{"properties":{"schedules":{"description":"任务详情。","items":{"$ref":"#/definitions/ScheduleDetailInfo"},"type":"array"},"total_count":{"description":"记录总数。","type":"string"}},"required":["total_count","schedules"],"type":"object"},"ScheduleDetailInfo":{"required":["job_id","job_name","job_status","instance_id","instance_name","instance_status","datastore_type","create_time","start_time","end_time"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"eccab6005e354f8d8fd0f3676ac66455","info_version":"v3","method":"get","name":"ListNosqlTaskList","parameters":{},"paths":{"/v3/{project_id}/scheduled-jobs":{"get":{"description":"根据指定条件查询定时任务列表。","operationId":"ListNosqlTaskList","parameters":[{"description":"用户在某一region下的projectId。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"任务名称,默认为空。对应取值如下:\n\t\"REBOOT\":重启实例\n\t\"RESIZE_FLAVOR\":变更实例的CPU和内存规格\n\t\"UPGRADE_DATABASE\":补丁升级","in":"query","name":"job_name","required":false,"type":"string"},{"description":"任务执行状态,默认为空。 取值:\n\t值为\"Pending\",表示任务未执行。\n\t值为\"Running\",表示任务正在执行。\n\t值为\"Completed\",表示任务执行成功。\n\t值为\"Failed\",表示任务执行失败。\n\t值为\"Canceled\",表示任务取消执行。","in":"query","name":"job_status","required":false,"type":"string"},{"description":"实例ID,不传该值默认查所有符合条件的实例。","in":"query","name":"instance_id","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"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0。","in":"query","name":"offset","required":false,"type":"string"},{"description":"查询记录数。不传该参数时,默认为10,取值范围1-100。","in":"query","name":"limit","required":false,"type":"string"}],"responses":{"200":{"description":"","examples":{"application/json":{"schedules":[{"create_time":"2019-05-26T10:41:14+0000","datastore_type":"GaussDB(for Cassandra)","end_time":"2019-05-26T12:51:14+0000","instance_id":"8a6117ece8a0457a90060441fa372e8ein06","instance_name":"gauss-nosql","instance_status":"normal","job_id":"56d3c1138dcf4f1da73b0170700c78d0","job_name":"REBOOT","job_status":"Pending","start_time":"2019-05-26T12:41:14+0000"}],"total_count":1}},"schema":{"$ref":"#/definitions/NoSqlQueryScheduleJobsResponseBody"}}},"summary":"查询定时任务列表","tags":["实例管理"],"x-api-type":"open-api","x-is-registered":"Y","x-request-examples-description-1":"根据指定条件查询定时任务列表。","x-request-examples-url-1":"GET https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/scheduled-jobs?offset=2&limit=2&start_time=2019-05-27T03:38:51+0000&job_status=Pending","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询定时任务列表","tags":"实例管理","uri":null,"version":"2.0"}