获取实例数据库列表 - ObtainingAllDatabasesinanInstance
功能介绍
获取Redis实例数据库列表。
接口约束
- 只支持GeminiDB Redis接口。
- 实例在创建、变更规格、修改端口、异常状态或冻结状态下不能执行该操作。
- 仅返回实例有数据的数据库列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:listDatabase
List
instance *
- g:ResourceTag/<tag-key>
- g:EnterpriseProjectId
- nosql:database:list
- nosql:backup:list
-
URI
GET /v3/{project_id}/redis/instances/{instance_id}/databases
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| instance_id | 是 | String | 参数解释： 实例ID，可以调用7.3.3 查询实例列表和详情接口获取。如果未申请实例，可以调用7.3.1 创建实例接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释： 索引位置，偏移量。 约束限制： 不涉及。 取值范围： 大于或等于0。 默认取值： 从第一条数据偏移offset条数据后开始查询，默认为0。 |
| limit | 否 | Integer | 参数解释： 查询个数上限值。 约束限制： 不涉及。 取值范围： 1~100。 默认取值： 不传该参数时，默认查询前100条信息。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| databases | Array of strings | 参数解释： Redis实例数据库列表。 取值范围： 不涉及。 |
| total_count | Integer | 参数解释： 总记录数。 取值范围： 不涉及。 |
请求示例
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/redis/instances/9136fd2a9fcd405ea4674276ce36dae8in12/databases 响应示例
状态码： 200
Success.
{
"databases" : [ "1", "2", "3" ],
"total_count" : 3
} 状态码
请参见状态码。
错误码
请参见错误码。
