{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"MysqlBackupListResponse":{"properties":{"backups":{"description":"备份信息。","items":{"$ref":"#/definitions/backups"},"type":"array"},"total_count":{"description":"备份文件的总数。","format":"int64","type":"integer"}}},"MysqlDatastoreInBackup":{"description":"数据库信息。","properties":{"type":{"description":"数据库引擎,现在只支持gaussdb-mysql。","type":"string"},"version":{"description":"数据库版本。\n\n数据库支持的版本信息,获取方法请参见[查询数据库引擎的版本](https://support.huaweicloud.com/api-gaussdbformysql/ShowGaussMySqlEngineVersion.html)返回的name字段。","type":"string"}},"required":["type","version"]},"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]},"backups":{"properties":{"backup_level":{"description":"备份级别。当开启一级备份开关时,返回该参数。","enum":["0","1","2"],"type":"string"},"begin_time":{"description":"备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。","type":"string"},"datastore":{"$ref":"#/definitions/MysqlDatastoreInBackup","description":"数据库信息。","type":"object"},"description":{"description":"备份文件描述信息。","type":"string"},"end_time":{"description":"备份结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。","type":"string"},"id":{"description":"备份ID。","type":"string"},"instance_id":{"description":"实例ID,严格匹配UUID规则。","type":"string"},"instance_name":{"description":"实例名称。","type":"string"},"name":{"description":"备份名称。","type":"string"},"size":{"description":"备份大小(单位:MB)。","format":"int64","type":"integer"},"status":{"description":"备份状态,取值:\n- BUILDING:备份中。\n- COMPLETED:备份完成。\n- FAILED:备份失败。\n- AVAILABLE:备份可用。","type":"string"},"take_up_time":{"description":"备份花费时间(单位:minutes)","format":"int32","type":"integer"},"type":{"description":"备份类型,取值:\n\n- auto:自动全量备份。\n- manual:手动全量备份。","type":"string"}}}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"116e9ab745904d28bf824ba4e460bae1","info_version":"v3","method":"get","name":"ShowGaussMySqlBackupList","parameters":{},"paths":{"/v3/{project_id}/backups":{"get":{"description":"查询全量备份列表。","operationId":"ShowGaussMySqlBackupList","parameters":[{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。\n","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","type":"string","x-example":"zh-cn"},{"description":"租户在某一Region下的project ID。 \n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdbformysql/gaussdbformysql_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID,严格匹配UUID规则。","in":"query","name":"instance_id","type":"string","x-example":"b90dff1436824f5e999e04cccc2147f5in07"},{"description":"备份ID。","in":"query","name":"backup_id","type":"string","x-example":"43a3e152545343f099e5c0684fd9ead9br07"},{"description":"备份类型。\n\n取值范围:\n- auto:自动全量备份。\n- manual:手动全量备份。","in":"query","name":"backup_type","type":"string","x-example":"auto"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","in":"query","name":"offset","type":"string"},{"description":"查询记录数。默认为100,不能为负数,最小值为1,最大值为100。","in":"query","name":"limit","type":"string"},{"description":"查询开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。","in":"query","name":"begin_time","type":"string"},{"description":"查询结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。","in":"query","name":"end_time","type":"string"},{"description":"备份名称。","in":"query","name":"name","type":"string"},{"description":"实例名称。","in":"query","name":"instance_name","type":"string"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"backups":[{"backup_level":"2","begin_time":"2020-07-08T18:41:14+0800","datastore":{"type":"gaussdb-mysql","version":"8.0"},"end_time":"2020-07-08T20:45:14+0800","id":"7420f28010084e838113e78f77093093br07","instance_id":"3ef58db3986540d19f95151309368d34in07","instance_name":"GaussDBforMySQL-gauss-e747","name":"GaussDBforMySQL-gauss-e747-20200708185048266","size":2803,"status":"COMPLETED","take_up_time":2,"type":"auto"}],"total_count":1}},"schema":{"$ref":"#/definitions/MysqlBackupListResponse"}},"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":"查询时间段内(2020-07-06~2020-07-16)的自动备份列表。","x-request-examples-url-1":"GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=3ef58db3986540d19f95151309368d34in07&backup_id=7420f28010084e838113e78f77093093br07&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询全量备份列表","tags":"备份管理","uri":null,"version":"2.0"}