huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20250523

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"QueryInstanceBackupResponseBody":{"properties":{"backups":{"description":"备份列表信息。","items":{"properties":{"begin_time":{"description":"备份开始时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。","format":"date-time","type":"string"},"datastore":{"description":"数据库信息。","properties":{"type":{"description":"数据库类型。","type":"string"},"version":{"description":"数据库版本。","type":"string"}},"required":["type","version"]},"description":{"description":"备份描述信息。","type":"string"},"end_time":{"description":"备份结束时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。","format":"date-time","type":"string"},"id":{"description":"备份ID。","type":"string"},"instance_id":{"description":"实例ID。","type":"string"},"instance_name":{"description":"实例名称。","type":"string"},"name":{"description":"备份名称。","type":"string"},"size":{"description":"备份大小,单位:KB。","format":"double","type":"number"},"status":{"description":"备份状态。","enum":["BUILDING:备份中","COMPLETED:备份完成","FAILED:备份失败"],"type":"string"},"type":{"description":"备份类型。","enum":["Auto 自动全量备份","Manual 手动全量备份。"],"type":"string"}},"required":["id","name","description","begin_time","end_time","status","size","type","instance_id","instance_name","datastore"]},"type":"array"},"total_count":{"description":"总记录数。","format":"int64","type":"integer"}},"required":["total_count"],"type":"object"}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"563884bea1664a4189c04fb735a9f84c","info_version":"v3","method":"get","name":"ShowAllInstancesBackups","parameters":{},"paths":{"/v3/{project_id}/backups":{"get":{"description":"根据指定条件查询备份列表。","operationId":"ShowAllInstancesBackups","parameters":[{"description":"用户在某一region下的projectId。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"用户Token。","in":"header","name":"x-auth-token","required":true,"type":"string"},{"description":"分页页码。","format":"int32","in":"query","minimum":1,"name":"offset","required":true,"type":"integer"},{"description":"每页条数。","format":"int32","in":"query","maximum":100,"minimum":1,"name":"limit","required":true,"type":"integer"},{"allowEmptyValue":true,"description":"引擎类型 不传该参数则查询所有的引擎。","enum":["cassandra","mongodb","redis","influxdb"],"in":"query","name":"datastore_type","required":false,"type":"string"},{"description":"实例ID 不传该参数则查询所有备份列表。","in":"query","name":"instance_id","required":false,"type":"string"},{"description":"备份ID。","in":"query","name":"backup_id","required":false,"type":"string"},{"description":"备份类型。","enum":["Auto 自动全量备份","Manual 手动全量备份。"],"in":"query","name":"backup_type","required":false,"type":"string"},{"description":"查询备份开始的时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。","in":"query","name":"begin_time","required":false,"type":"string"},{"description":"查询备份开始的结束时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。","in":"query","name":"end_time","required":false,"type":"string"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"backups":[{"begin_time":"2022-01-01 00:00:00","datastore":{"type":"redis","version":"5.0.4.0"},"description":"创建备份test","end_time":"2022-01-01 01:00:00","id":"042359855a184ce68cfe27deb5d5fdd8br12","instance_id":"afab085da48748138eaaec11ed09fd30in12","instance_name":"redis-ff23","name":"backup-f698","size":1160.60254,"status":"COMPLETED","type":"Manual"}],"total_count":1}},"schema":{"$ref":"#/definitions/QueryInstanceBackupResponseBody"}},"default":{"description":"Client or server error."}},"summary":"查询备份列表","tags":["备份与恢复"],"x-is-registered":"Y","x-request-examples-url-1":"GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups?offset=1&limit=10&datastore_type=cassandra&instance_id=","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询备份列表","tags":"备份与恢复","uri":null,"version":"2.0"}