文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 获取GeminiDB Redis的免密配置
更新时间：2024-10-28 GMT+08:00
查看PDF
分享

获取GeminiDB Redis的免密配置

功能介绍

获取GeminiDB Redis的免密配置。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Redis

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/instances/{instance_id}/passwordless-config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置偏移量，表示从查询到的免密配置列表偏移offset条数据后查询对应的免密配置。

取值大于或等于0。不传该参数时，查询偏移量默认为0，表示从第一条记录开始查询。

limit

否

Integer

查询个数上限值，取值范围：1~100。不传该参数时，默认查询前100条记录。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

config_ips

Array of strings

免密配置，IP与网段的列表，仅支持ipv4的IP或网段。

total_count

Integer

免密配置的总数。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/b31f6915c8be45e38958eac14e96a5d2in12/passwordless-config

响应示例

状态码： 200

Success.

{ 
   "config_ips" : [ "10.23.26.0/24" ], 
   "total_count" : 1 
 }

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档