查询数据库列表
URI
GET /v3/{project_id}/instances/{instance_id}/databases
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID，严格匹配UUID规则。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 |
limit |
否 |
Integer |
查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 |
name |
否 |
String |
数据库名称。 |
charset |
否 |
String |
数据库使用的字符集，如utf8mb4、gbk等。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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 |
数据库总数。 |
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
数据库名称。 |
charset |
String |
数据库使用的字符集，如utf8mb4、gbk等。 |
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
}
状态码
请参见状态码。
错误码
请参见错误码。
