huawei-cloud-api-definitions-RDS 0.1.20260724

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"BackupDatabase":{"properties":{"name":{"description":"SqlServer引擎指定备份的数据库。","type":"string"}},"required":["name"]},"BackupDatastore":{"properties":{"type":{"description":"数据库引擎,不区分大小写:\n- MySQL\n- PostgreSQL\n- SQLServer\n- MariaDB","enum":["MySQL","PostgreSQL","SQLServer","MariaDB"],"type":"string"},"version":{"description":"数据库版本。","type":"string"}},"required":["type","version"]},"BackupForList":{"description":"备份信息。","properties":{"associated_with_ddm":{"description":"是否已被DDM实例关联。","type":"boolean"},"begin_time":{"description":"备份开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","type":"string"},"databases":{"description":"备份的数据库。","items":{"$ref":"#/definitions/BackupDatabase"},"type":"array"},"datastore":{"$ref":"#/definitions/BackupDatastore"},"end_time":{"description":"备份结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。\n\n其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。","type":"string"},"id":{"description":"备份ID。","type":"string"},"instance_id":{"description":"实例ID。","type":"string"},"min_data_volume_capacity_for_restore":{"description":"该备份源文件大小,用于该备份文件恢复到新实例时需要的最小磁盘空间大小。","type":"integer"},"name":{"description":"备份名称。","type":"string"},"size":{"description":"备份大小,单位为KB。","format":"int64","type":"integer"},"status":{"description":"备份状态,取值:\n\n- BUILDING: 备份中。\n- COMPLETED: 备份完成。\n- FAILED:备份失败。\n- DELETING:备份删除中。","enum":["BUILDING","COMPLETED","FAILED","DELETING"],"type":"string"},"type":{"description":"备份类型,取值:\n\n- “auto”: 自动全量备份\n- “manual”: 手动全量备份\n- “fragment”: 差异全量备份\n- “incremental”: 自动增量备份","enum":["auto","manual","fragment","incremental"],"type":"string"}},"required":["id","instance_id","name","begin_time","end_time","status","type","size","datastore"]},"ErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例名称已存在。","type":"string"}},"required":["error_code","error_msg"]},"ListBackupsResponseBody":{"properties":{"backups":{"description":"备份信息。","items":{"$ref":"#/definitions/BackupForList"},"type":"array"},"total_count":{"description":"总记录数。","type":"integer"}},"required":["backups","total_count"]}},"description":null,"group_id":"b7735f867ef44182af9eb77490a46fbf","host":"rds.cn-north-4.myhuaweicloud.com","id":"2369e55f764f4ca382e3c6acde71f60c","info_version":"v3","method":"get","name":"ListBackups","parameters":{},"paths":{"/v3/{project_id}/backups":{"get":{"description":"获取备份列表。","operationId":"ListBackups","parameters":[{"description":"用户Token。","in":"header","name":"x-auth-token","required":false,"type":"string","x-example":"******"},{"description":"语言","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"项目ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID。","in":"query","name":"instance_id","required":true,"type":"string"},{"description":"备份ID。","in":"query","name":"backup_id","required":false,"type":"string"},{"description":"备份类型,取值:\n\n- “auto”: 自动全量备份\n- “manual”: 手动全量备份\n- “fragment”: 差异全量备份\n- “incremental”: 自动增量备份","enum":["auto","manual","fragment","incremental"],"in":"query","name":"backup_type","required":false,"type":"string"},{"description":"备份状态,只支持筛选RDS for SQL Server的全量备份的状态。取值:\n\n- “BUILDING”: 备份中\n- “COMPLETED”: 备份完成\n- “FAILED”: 备份失败","enum":["BUILDING","COMPLETED","FAILED"],"in":"query","name":"status","required":false,"type":"string"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","in":"query","minimum":0,"name":"offset","required":false,"type":"integer"},{"description":"查询记录数。默认为100,不能为负数,最小值为1,最大值为100。","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"},{"description":"查询开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。与end_time必须同时使用。","in":"query","name":"begin_time","required":false,"type":"string"},{"description":"查询结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。与begin_time必须同时使用。","in":"query","name":"end_time","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"backups":[{"associated_with_ddm":false,"begin_time":"2018-08-06T12:41:14+0800","databases":[{"name":"user01"},{"name":"user02"}],"datastore":{"type":"SQLServer","version":"2014_WEB"},"end_time":"2018-08-06T12:43:14+0800","id ":"43e4feaab48f11e89039fa163ebaa7e4br04","instance_id":"a48e43ff268f4c0e879652d65e63d0fbin04","name":"xxxx.xxx","size":2803,"status":"COMPLETED","type":"manual"}],"total_count":1}},"schema":{"$ref":"#/definitions/ListBackupsResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponse"}}},"summary":"获取备份列表","tags":["备份与恢复"],"x-constraint":"该接口支持查询MySQL、PostgreSQL、Microsoft SQL Server的全量备份,以及MySQL的增量备份。","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://rds.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/backups?instance_id=a48e43ff268f4c0e879652d65e63d0fbin04","x-support-sdk":"Y"}}},"product_short":"RDS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取备份列表","tags":"备份与恢复","uri":null,"version":"2.0"}