查询数据库列表
URI
GET /v3/{project_id}/instances/{instance_id}/clickhouse/databases
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一Region下的project ID。 获取方法请参见获取项目ID。 |
|
instance_id |
是 |
String |
ClickHouse实例ID，严格匹配UUID规则。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
查询记录数，默认10。不能为负数，最小值为1，最大值为100。 |
|
offset |
否 |
Integer |
索引位置，偏移量，默认0。从第一条数据偏移offset条数据后开始查询（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 |
|
database_name |
否 |
String |
数据库名。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
X-Language |
否 |
String |
请求语言类型。默认en-us。 取值范围：
|
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
databases |
Array of strings |
数据库列表。 |
|
total_count |
Integer |
数据库总数。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
查询实例前10个数据库。
GET https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/databases?limit=10&offset=1&database_name=
响应示例
状态码： 200
Success.
{
"databases": [
"black_0003_47852503",
"blackwhite_0017_22525694",
"blackwhite_0022_05703881",
"blackwhite_0022_74636728",
"db_par_00473111",
"db_par_06456394",
"db_par_09021212",
"db_par_12417082",
"db_par_14323386",
"db_par_19408230"
],
"total_count": 42,
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success. |
|
400 |
Client error. |
|
500 |
Server error. |
错误码
请参见错误码。
