{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"JobDetail":{"description":"任务信息。","properties":{"end_time":{"description":"结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","type":"string"},"fail_reason":{"description":"任务执行失败时的错误信息。","type":"string"},"id":{"description":"任务ID","type":"string"},"instance":{"$ref":"#/definitions/JobInstanceInfo","description":"任务关联的实例信息。"},"name":{"description":"任务名称。","type":"string"},"progress":{"description":"任务执行进度。\n> 执行中状态才返回执行进度,例如“60%”,表示任务执行进度为60%,否则返回“”。","type":"string"},"start_time":{"description":"创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","type":"string"},"status":{"description":"任务执行状态。\n取值:\nRunning:表示任务正在执行。\nCompleted:表示任务执行成功。\nFailed:表示任务执行失败。\n\n枚举值:\nRunning\nCompleted\nFailed","type":"string"}},"required":["id","name","status","start_time","end_time","progress","instance","fail_reason"],"type":"object"},"JobInstanceInfo":{"description":"执行任务的实例信息。","properties":{"id":{"description":"实例ID。","type":"string"},"name":{"description":"实例名称。","type":"string"}},"required":["id","name"],"type":"object"},"JobListResponse":{"properties":{"jobs":{"description":"任务列表。","items":{"$ref":"#/definitions/JobDetail"},"type":"array"},"total_count":{"description":"任务列表总数","format":"int32","type":"integer"}},"required":["jobs","total_count"],"type":"object"}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"1ae54945241b4c39ae3064851861b2ba","info_version":"v3","method":"get","name":"ListJobs","parameters":{},"paths":{"/v3/{project_id}/jobs":{"get":{"description":"查询任务列表和详情,默认查询任务列表。","operationId":"ListJobs","parameters":[{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"任务ID。","in":"query","name":"id","required":false,"type":"string"},{"description":"查询开始时间,默认当前时间往前30天,格式为“yyyy-mm-ddThh:mm:ssZ”。\n其中,T指某个时间的开始,Z指时区偏移量","in":"query","name":"start_time","required":false,"type":"string"},{"description":"查询结束时间,默认当前时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间,时间跨度不超过30天。\n其中,T指某个时间的开始,Z指时区偏移量。","in":"query","name":"end_time","required":false,"type":"string"},{"description":"任务状态: 取值为“Running”为执行中; 取值为“Completed”为完成; 取值为“Failed” 为失败。","in":"query","name":"status","required":false,"type":"string"},{"description":"任务名称。对应取值如下:\n- \"CreateInstance\":创建实例\n- \"RestoreNewInstance\":恢复到新实例\n- \"EnlargeInstance\":扩容实例\n- \"ReduceInstance\":缩容实例\n- \"RestartInstance\":重启实例\n- \"RestartNode\":重启节点\n- \"EnlargeInstanceVolume\":扩容实例磁盘\n- \"ReduceInstanceVolume\":缩容实例磁盘\n- \"ResizeInstance\":规格变更实例\n- \"UpgradeDbVersion\":升级数据库版本\n- \"BindPublicIP\":绑定公网IP\n- \"UnbindPublicIP\":解绑公网IP\n- \"DeleteInstance\":删除实例\n- \"EnlargeInstanceColdVolume\":扩容实例冷存储\n- \"AddInstanceColdVolume\":增加实例冷存储\n- \"ModifySecurityGroup\":修改安全组\n\n- \"ModifyPort\":修改端口\n- \"ConstructDisasterRecovery\":构造容灾关系\n- \"DeConstructDisasterRecovery\":解除容灾关系\n- \"SwitchOverDisasterRecovery\":切换容灾关系\n- \"BuildBiActiveInstance\":构建双活实例\n- \"ReleaseBiActiveInstance\":解除双活实例关系\n- \"BackupInstance\":备份实例","in":"query","name":"name","required":false,"type":"string"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"description":"查询记录数。取值 10 20 50 ,默认为50。","format":"int32","in":"query","name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"jobs":[{"end_time":"2023-09-12T06:44:03+0000","fail_reason":"","id":"6f85e061-04dd-42e7-86d6-d3b1e40aac2e","instance":{"id":"27a045b6bf9e46f691f81366d398cb04in06","name":"nosql-12f5"},"name":"CreateCassandra","progress":"14%","start_time":"2023-09-12T06:44:01+0000","status":"Running"}],"total_count":1}},"schema":{"$ref":"#/definitions/JobListResponse"}}},"summary":"查询任务列表和详情","tags":["任务管理"],"x-constraint":"","x-is-registered":"Y","x-request-examples-description-1":"URI样例","x-request-examples-url-1":"GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/jobs?id=89a0cde6-9c46-4b89-a92c-573e1083ff23","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询任务列表和详情","tags":"任务管理","uri":null,"version":"2.0"}