huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20240122

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"QueryRestorableTimeResponseBody":{"properties":{"restorable_time_periods":{"description":"实例可恢复的时间段","items":{"$ref":"#/definitions/RestorableTime"},"type":"array"},"total_count":{"description":"实例可恢复时间段总数","format":"int32","type":"integer"}},"required":["total_count"]},"RestorableTime":{"description":"可恢复的时间段","properties":{"end_time":{"description":"可恢复时间段的结束时间点, UNIX时间戳格式,单位是毫秒,时区是UTC。","format":"int64","type":"integer"},"start_time":{"description":"可恢复时间段的开始时间点,UNIX时间戳格式,单位是毫秒,时区是UTC。","format":"int64","type":"integer"}},"required":["start_time","end_time"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"ba747751da5342ac8c2857f8d995cb8c","info_version":"v3","method":"get","name":"ListRestoreTime","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/backups/restorable-time-periods":{"get":{"description":"查询实例可恢复的时间段","operationId":"ListRestoreTime","parameters":[{"description":"用户token。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"用户在某一region下的projectId。","in":"path","name":"project_id","required":true,"type":"string","x-example":"375d8d8fad1f43039e23d3b6c0f60a19"},{"description":"实例Id,可以调用[5.3.3 查询实例列表和详情](x-wc://file=zh-cn_topic_0000001397299481.xml)接口获取。如果未申请实例,可以调用[5.3.1 创建实例](x-wc://file=zh-cn_topic_0000001397139461.xml)接口创建。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"a4d8ea2584e047439a667703c0684119in06"},{"description":"查询的可恢复时间段的开始时间点,为yyyy-mm-ddThh:mm:ssZ字符串格式,T指某个时间的开始,Z指时区偏移量。\n\n[例如北京时间偏移显示为+0800。默认值为当前查询时间的前一天。]","in":"query","name":"start_time","required":false,"type":"string","x-example":"2022-06-01T18:50:20+0800"},{"description":"查询的可恢复时间段的结束时间点,为yyyy-mm-ddThh:mm:ssZ字符串格式,T指某个时间的开始,Z指时区偏移量。\n\n[例如北京时间偏移显示为+0800。默认值为当前查询时间。]","in":"query","name":"end_time","required":false,"type":"string","x-example":"2022-06-02T18:50:20+0800"},{"description":"偏移量,表示查询该偏移量后面的记录,默认值为0。","in":"query","name":"offset","required":false,"type":"integer","x-example":0},{"description":"查询返回记录的数量上限值,取值范围为0~1000,默认值为1000。","in":"query","name":"limit","required":false,"type":"integer","x-example":1000}],"responses":{"200":{"description":"Success","examples":{"application/json":{"restorable_time_periods":[{"end_time":1607731200000,"start_time":1607731200000}],"total_count":1}},"schema":{"$ref":"#/definitions/QueryRestorableTimeResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"查询实例可恢复的时间段","tags":["备份与恢复"],"x-constraint":"该接口支持如下数据库实例:\n- GeminiDB Cassandra\n- GeminiDB Influx\n\n使用该接口前,需确保自动备份策略已开启。\n\n该接口目前仅支持查询实例可恢复的时间点,所以“start_time”和“end_time”的参数取值是相同的。","x-is-registered":"N","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=1000","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询实例可恢复的时间段","tags":"备份与恢复","uri":null,"version":"2.0"}