查询LTS日志配置信息
功能介绍
查询实例的LTS配置。
接口约束
慢日志配置信息查询支持如下数据库:
- GeminiDB Redis
审计日志配置信息查询支持如下数据库:
- GeminiDB Redis
- GeminiDB Mongo
URI
GET /v3/{project_id}/instances/logs/lts-configs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
索引位置偏移量,表示从第一条数据偏移offset条数据后开始查询。取值必须为数字,不能为负数。默认取0值,表示从第一条数据开始查询。 |
|
limit |
否 |
Integer |
返回的最大记录数量。取值范围:1~100,必须为整数。不传该参数时,默认查询100条实例信息。 |
|
instance_id |
否 |
String |
根据实例ID精确搜索。 |
|
instance_name |
否 |
String |
根据实例名称模糊搜索。 |
|
enterprise_project_id |
否 |
String |
根据企业项目ID精确搜索。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 |
|
X-Language |
否 |
String |
语言。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
实例总记录数。 |
|
instance_lts_configs |
Array of objects |
实例的LTS日志配置信息列表。详情请参考表5。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance |
object |
实例信息。详情请参考表6。 |
|
lts_configs |
Array of objects |
LTS日志配置明细。若未设置LTS日志流,不返回该字段。详情请参考表8。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
实例ID。 |
|
name |
String |
实例名称。 |
|
status |
String |
实例状态。取值:
|
|
mode |
String |
实例类型。
|
|
datastore |
object |
数据库信息。详情请参考表7。 |
|
actions |
Array of strings |
实例正在执行的动作。 |
|
enterprise_project_id |
String |
企业项目ID。 |
|
supported_log_types |
Array of strings |
支持的日志类型。取值: slow_log,表示慢日志。 audit_log,表示审计日志。 |
请求示例
GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/logs/lts-configs?limit=10&offset=0&instance_id=362b42f769ff45d884e1866f8ee00bb4in12&instance_name=c316&enterprise_project_id=0
响应示例
状态码: 200
Success
{
"total_count" : 1,
"instance_lts_configs" : [ {
"instance" : {
"id" : "362b42f769ff45d884e1866f8ee00bb4in12",
"name" : "nosql-c316",
"mode" : "RedisCluster",
"datastore" : {
"version" : "5.0",
"type" : "redis"
},
"status" : "normal",
"actions" : [ "GROWING" ],
"enterprise_project_id" : "0",
"supported_log_types" : [ "slow_log", "audit_log" ]
},
"lts_configs" : [ {
"log_type" : "slow_log",
"lts_group_id" : "65442dd4-b8de-4e9f-8a80-b60aa0698354",
"lts_stream_id" : "5992dd29-fd11-4228-a852-5f6e578789c5",
"enabled" : true
} ]
} ]
}
状态码
请参见状态码。
错误码
请参见错误码。