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":{"GaussMySqlDatabaseInfo":{"description":"已授权数据库用户信息。","properties":{"host":{"description":"主机地址。","type":"string"},"name":{"description":"数据库用户名。","type":"string"},"readonly":{"description":"是否为只读权限:\n- true,表示只读。\n- false,表示可读写。","type":"boolean"}}},"ListGaussMySqlDatabaseResponseBody":{"description":"查询数据库列表响应体。","properties":{"databases":{"description":"数据库信息列表。","items":{"$ref":"#/definitions/ListGaussMysqlDatabaseInfo"},"type":"array"},"total_count":{"description":"数据库总数。","format":"int32","type":"integer"}}},"ListGaussMysqlDatabaseInfo":{"description":"数据库信息。","properties":{"charset":{"description":"数据库使用的字符集,如utf8mb4、gbk等。","type":"string"},"comment":{"description":"数据库备注。","type":"string"},"name":{"description":"数据库名称。","type":"string"},"users":{"description":"已授权数据库用户列表。","items":{"$ref":"#/definitions/GaussMySqlDatabaseInfo"},"type":"array"}}},"MysqlErrorResponse":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200022","type":"string"},"error_msg":{"description":"错误消息。","example":"实例不存在","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"17822ccca2ef4036b5915b3ffc7c8bcb","info_version":"v3","method":"get","name":"ListGaussMySqlDatabase","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/databases":{"get":{"description":"查询 TaurusDB实例数据库。","operationId":"ListGaussMySqlDatabase","parameters":[{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"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","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"a23fb62bd61e4e9e9636fd2225f395bein07"},{"description":"索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。","format":"int32","in":"query","name":"offset","type":"integer","x-example":"0"},{"description":"查询记录数。默认为100,不能为负数,最小值为1,最大值为100。","format":"int32","in":"query","name":"limit","type":"integer","x-example":"100"},{"description":"数据库名称。","in":"query","name":"name","type":"string","x-example":"risk"},{"description":"数据库使用的字符集,如utf8mb4、gbk等。","in":"query","name":"charset","type":"string","x-example":"utf8"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"databases":[{"charset":"utf8mb4","comment":"database_comment","name":"test","users":[{"host":"127.0.0.1","name":"gaussdb_mysql_user1","readonly":false}]}],"total_count":1}},"schema":{"$ref":"#/definitions/ListGaussMySqlDatabaseResponseBody"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/MysqlErrorResponse"}}},"summary":"查询数据库列表","tags":["数据库管理"],"x-is-registered":"N","x-request-examples-description-1":"查询数据库列表。","x-request-examples-url-1":"GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases?offset=0&limit=100&charset=utf8mb4&name=test","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询数据库列表","tags":"数据库管理","uri":null,"version":"2.0"}