huawei-cloud-api-definitions-GaussDB 0.1.20250124

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]},"RecycleInstanceV3":{"properties":{"backup_level":{"description":"备份级别。","type":"string"},"create_at":{"description":"创建时间。","type":"integer"},"data_vip":{"description":"数据面VIP。","type":"string"},"data_vip_ipv6":{"description":"数据面IPV6。","type":"string"},"deleted_at":{"description":"删除时间。","type":"integer"},"engine_name":{"description":"引擎名称。","type":"string"},"engine_version":{"description":"引擎版本。","type":"string"},"enterprise_project_id":{"description":"企业项目ID。","type":"string"},"enterprise_project_name":{"description":"企业项目名称。","type":"string"},"ha_mode":{"description":"实例类型。","type":"string"},"id":{"description":"实例ID。","type":"string"},"name":{"description":"实例名称。","type":"string"},"pay_model":{"description":"计费模式。","type":"string"},"recycle_backup_id":{"description":"备份ID。","type":"string"},"recycle_status":{"description":"回收状态。","type":"string"},"volume_size":{"description":"磁盘大小。","type":"string"},"volume_type":{"description":"磁盘类型。","type":"string"}}},"RecycleInstancesRspV3":{"properties":{"instances":{"description":"回收站实例信息","items":{"$ref":"#/definitions/RecycleInstanceV3"},"type":"array"},"total_count":{"description":"数据总数","type":"string"}}}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"6ae1d78faa104ac8817e6017a0a4e15e","info_version":"v3","method":"get","name":"ListRecycleInstances","parameters":{},"paths":{"/v3/{project_id}/instances/recycle-info":{"get":{"description":"查询回收站实例信息","operationId":"ListRecycleInstances","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":"内容类型。\n\n取值:application/json。\n","in":"header","name":"Content-Type","required":true,"type":"string","x-example":"application/json"},{"description":"语言。","in":"header","name":"X-Language","required":false,"type":"string","x-example":"zh-cn"},{"description":"租户在某一Region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。\n","in":"path","name":"project_id","required":true,"type":"string"},{"description":"查询记录数。默认为10,不能为负数,最小值为1,最大值为100。","in":"query","name":"limit","required":false,"type":"integer"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","in":"query","name":"offset","required":false,"type":"integer"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"instances":[{"backup_level":"2","create_at":1712656933705,"data_vip":"172.16.1.234","data_vip_ipv6":null,"deleted_at":1712659228276,"engine_name":"taurus","engine_version":"2.0.51.240300","enterprise_project_id":"0","enterprise_project_name":"default","ha_mode":"StandSingle","id":"090e539b45e047ee9cc17750b321ef7ein07","name":"gauss-dd-single","pay_model":"0","recycle_backup_id":"c62e218ccd6c49098baa925453c65e29br07","recycle_status":"Active","volume_size":"0","volume_type":""},{"backup_level":"2","create_at":1712658210524,"data_vip":"172.16.1.194","data_vip_ipv6":null,"deleted_at":1712659158927,"engine_name":"taurus","engine_version":"2.0.51.240300","enterprise_project_id":"0","enterprise_project_name":"default","ha_mode":"StandSingle","id":"632423cc56c348bd967b3a03e7abdab9in07","name":"gauss-dd-single","pay_model":"0","recycle_backup_id":"70d03dc459304f7298c0f5b49286f37cbr07","recycle_status":"Active","volume_size":"0","volume_type":""}],"total_count":2}},"schema":{"$ref":"#/definitions/RecycleInstancesRspV3"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"查询回收站实例信息","tags":["实例管理"],"x-apigateway-ratelimit":"gaussdbformysql_console_policy","x-file":"gh-330","x-is-registered":"Y","x-request-examples-description-1":"查询回收站实例信息","x-request-examples-url-1":"GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/recycle-info","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询回收站实例信息","tags":"实例管理","uri":null,"version":"2.0"}