查询数据库列表
URI
GET /v3/{project_id}/instances/{instance_id}/databases
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 必须为整数,不能为负数。 取值范围: ≥0 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 查询记录数。 约束限制: 必须为整数,不能为负数。 取值范围: 1-100 默认取值: 100 |
name |
否 |
String |
参数解释: 数据库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
charset |
否 |
String |
参数解释: 数据库使用的字符集。 获取方法参见查询数据库可用字符集。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围:
默认值: en-us。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
databases |
Array of ListGaussMysqlDatabaseInfo objects |
参数解释: 数据库信息列表。 |
total_count |
Integer |
参数解释: 数据库总数。 取值范围: ≥0 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 数据库名称。 取值范围: 不涉及 |
charset |
String |
参数解释: 数据库使用的字符集。 取值范围: 不涉及 |
comment |
String |
参数解释: 数据库备注。 取值范围: 不涉及。 |
users |
Array of GaussMySqlDatabaseInfo objects |
参数解释: 已授权数据库用户列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 数据库用户名。 取值范围: 不涉及。 |
host |
String |
参数解释: 主机地址。 取值范围: 不涉及。 |
readonly |
Boolean |
参数解释: 是否为只读权限。 取值范围:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
查询数据库列表。
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/databases?offset=0&limit=100&charset=utf8mb4&name=test
响应示例
状态码: 200
Success.
{ "databases" : [ { "name" : "test", "charset" : "utf8mb4", "comment" : "database_comment", "users" : [ { "name" : "gaussdb-mysql-instance1", "host" : "127.0.0.1", "readonly" : false } ] } ], "total_count" : 1 }
状态码
请参见状态码。
错误码
请参见错误码。