查询自动扫描配置
功能介绍
查询过期key自动扫描配置。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/instances/{instance_id}/scan-expire-keys/autoscan-config
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID。 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instance_id |
String |
实例ID。 |
enable_auto_scan |
Boolean |
是否开启自动扫描。 |
first_scan_at |
String |
首次扫描时间,例如:2023-07-07T15:00:05.000。 |
interval |
Integer |
间隔时间(单位:秒)。 |
timeout |
Integer |
超时时间(单位:秒)。 |
scan_keys_count |
Integer |
扫描密钥计数。 |
updated_at |
String |
更新时间,例如:2023-06-15T06:20:13.283Z |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信(暂未使用,赋值为null)。 最大长度:1024 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息。 最大长度:1024 |
error_code |
String |
错误码。 最大长度:9 |
error_ext_msg |
String |
扩展错误信(暂未使用,赋值为null)。 最大长度:1024 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/scan-expire-keys/autoscan-config
响应示例
状态码: 200
查询自动扫描配置成功。
{ "instance_id" : "162d315d-a67d-4ba1-8ca5-8d0e95c5bf7c", "enable_auto_scan" : false, "first_scan_at" : null, "interval" : null, "timeout" : null, "scan_keys_count" : null, "updated_at" : null }
状态码
状态码 |
描述 |
---|---|
200 |
查询自动扫描配置成功。 |
400 |
非法请求。 |
401 |
认证信息非法。 |
403 |
请求被拒绝访问。 |
404 |
所请求的资源不存在。 |
500 |
内部服务错误。 |
错误码
请参见错误码。