{"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"]},"GetRecycleInstancesResponseBody":{"properties":{"instances":{"description":"**参数解释:**\n实例信息。\n**取值范围:**\n不涉及。","items":{"$ref":"#/definitions/RecycleInstance"},"type":"array"},"total_count":{"description":"**参数解释:**\n总记录数。\n**取值范围:**\n不涉及。","type":"integer"}}},"RecycleDatastore":{"description":"数据库信息。","properties":{"type":{"description":"数据库类型。\n - 取值为“cassandra”,表示GeminiDB Cassandra数据库实例。\n - 取值为“mongodb”,表示GeminiDB Mongo数据库实例。\n - 取值为“influxdb”,表示GeminiDB Influx数据库实例。\n - 取值为“redis”,表示GeminiDB Redis数据库实例。","type":"string"},"version":{"description":"数据库版本。","type":"string"}},"required":["type","version"]},"RecycleInstance":{"description":"回收备份实例信息。","properties":{"backup_id":{"description":"**参数解释:**\n备份ID。\n**取值范围:**\n不涉及。","type":"string"},"charge_type":{"description":"**参数解释:**\n计费方式。\n**取值范围:**\n- prePaid:预付费,即包年/包月。\n- postPaid:后付费,即按需付费。","type":"string"},"created_at":{"description":"**参数解释:**\n实例创建时间。\n**取值范围:**\n不涉及。","type":"string"},"data_store":{"$ref":"#/definitions/RecycleDatastore","description":"**参数解释:**\n数据库信息。\n**取值范围:**\n不涉及。","type":"object"},"deleted_at":{"description":"**参数解释:**\n实例删除时间。\n**取值范围:**\n不涉及。","type":"string"},"enterprise_project_id":{"description":"**参数解释:**\n企业项目ID,取值为“0”,表示为default企业项目\n**取值范围:**\n不涉及。","type":"string"},"id":{"description":"**参数解释:**\n实例ID。\n**取值范围:**\n不涉及。","type":"string"},"mode":{"description":"**参数解释:**\n实例类型。\n**取值范围:**\n- 取值为“Cluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis Proxy经典部署模式集群实例类型。\n- 取值为“CloudNativeCluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。\n- 取值为“RedisCluster”,表示GeminiDB Redis Cluster经典部署模式集群实例类型。\n- 取值为“Replication”,表示GeminiDB Redis经典部署模式主备实例类型。\n- 取值为“InfluxdbSingle”,表示GeminiDB Influx经典部署模式单节点实例类型。\n- 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。","type":"string"},"name":{"description":"**参数解释:**\n实例名称。\n**取值范围:**\n不涉及。","type":"string"},"product_type":{"description":"**参数解释:**\n产品类型。\n**取值范围:**\nGeminiDB Redis云原生部署模式集群涉及此字段,取值:\n - Standard 标准型\n - Capacity 容量型","type":"string"},"retained_until":{"description":"**参数解释:**\n回收备份保留截止时间。\n**取值范围:**\n不涉及。","type":"string"}}}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"bea880edb978466c80b205ae5e5ab2ac","info_version":"v3","method":"get","name":"ListRecycleInstances","parameters":{},"paths":{"/v3/{project_id}/recycle-instances":{"get":{"description":"查询回收站所有引擎的实例列表。","operationId":"ListRecycleInstances","parameters":[{"description":"**参数解释:**\n用户Token。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"语言。","in":"header","name":"X-Language","type":"string","x-example":"zh-cn"},{"description":"**参数解释:**\n租户在某一region下的project ID。获取方法请参见“获取项目ID”。\n**约束限制:**\n不涉及。\n**取值范围:**\n不涉及。\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string","x-example":"054991d39500d3c52f90c01c9004ae61"},{"description":"**参数解释:**\n索引位置,偏移量。\n索引位置偏移量。从第一条数据偏移offset条数据后开始查询。\n**约束限制:**\n大于或等于0。\n**取值范围:**\n不涉及。\n**默认取值:**\n0,表示从第一条数据开始查询。","in":"query","name":"offset","required":false,"type":"integer","x-example":0},{"description":"**参数解释:**\n查询个数上限值。\n**约束限制:**\n不涉及。\n**取值范围:**\n1~100。\n**默认取值:**\n100。","in":"query","name":"limit","required":false,"type":"integer","x-example":100}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"instances":[{"backup_id":"bf9ee62a7f7044c583c6765c916c36edbr02","charge_mode":"postPaid","created_at":"2022-01-01T10:00:00","datastore":{"type":"cassandra","version":"3.11"},"deleted_at":"2022-02-01T11:00:00","enterprise_project_id":"0","id":"07fc12a8e0e94df7a3fcf53d0b5e1605in02","mode":"Cluster","name":"test","retained_until":"2022-02-02T11:00:00"}],"total_count":1}},"schema":{"$ref":"#/definitions/GetRecycleInstancesResponseBody"}},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"查询回收站实例列表","tags":["备份与恢复"],"x-is-registered":"N","x-request-examples-description-1":"","x-request-examples-url-1":"GET https://{endpoint}/v3/054991d39500d3c52f90c01c9004ae61/instances/recycle-instances?offset=0&limit=100","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询回收站实例列表","tags":"备份与恢复","uri":null,"version":"2.0"}