查询LTS配置列表 - ListLogLtsConfigs
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rds:instance:listAll | - | - | - | rds:instance:list | - |
URI
- URI格式
GET /v3/{project_id}/{engine}/instances/logs/lts-configs?offset={offset}&limit={limit}&instance_name={instance_name}&instance_id={instance_id}
- 参数说明
表1 参数说明 名称
是否必选
参数类型
说明
project_id
是
String
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
engine
是
String
参数解释：
引擎类型。
约束限制：
不涉及。
取值范围：
mysql、postgresql、sqlserver，不区分大小写。
默认取值：
不涉及。
offset
否
Integer
参数解释：
索引位置，偏移量。表示从第一条数据偏移offset条数据后开始查询。
约束限制：
不涉及。
取值范围：
大于等于0的整数。
默认取值：
默认为0。偏移0条数据，表示从第一条数据开始查询。
limit
否
Integer
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
[1, 100]
默认取值：
100
instance_name
否
String
参数解释：
实例名称，按照实例名称过滤。
可调用查询数据库实例列表接口，通过表4中的“name”获取。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
否
String
参数解释：
实例ID，按照实例ID过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
无。
请求示例
GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/mysql/instances/logs/lts-configs 响应消息
- 正常响应要素说明
表2 要素说明 名称
参数类型
说明
total_count
Integer
参数解释：
结果集总数。
取值范围：
不涉及。
instance_lts_configs
Array of objects
参数解释：
实例LTS配置列表，请参见表3。
表3 instance_lts_configs字段说明 名称
参数类型
说明
lts_configs
Array of objects
参数解释：
LTS配置信息，请参见表4。
instance
object
参数解释：
实例信息，请参见表5。
表4 lts_configs字段说明 参数
参数类型
描述
log_type
String
参数解释：
日志类型。
取值范围：
- audit_log：审计日志。
- error_log：错误日志。
- slow_log：慢日志。
lts_group_id
String
参数解释：
LTS日志组ID。
取值范围：
不涉及。
lts_stream_id
String
参数解释：
LTS日志流ID。
取值范围：
不涉及。
enabled
Boolean
参数解释：
LTS配置是否开启。
取值范围：
- true：开启。
- false：关闭。
表5 instance字段说明 参数
参数类型
描述
id
String
参数解释：
实例ID。
取值范围：
不涉及。
name
String
参数解释：
实例名称。
取值范围：
不涉及。
engine_name
String
参数解释：
引擎名称。
取值范围：
不涉及。
engine_version
String
参数解释：
引擎版本。
取值范围：
不涉及。
engine_category
String
参数解释：
引擎类别。
取值范围：
不涉及。
status
String
参数解释：
实例状态。
取值范围：
- 值为“creating”，表示实例正在创建。
- 值为“createfail”，表示实例创建失败。
- 值为“normal”，表示实例正常。
- 值为“abnormal”，表示实例异常。
- 值为“data_disk_full”，表示实例磁盘空间满。
- 值为“deleted”，表示实例已经被删除。
- 值为“shutdown”，表示实例处于停止状态。
enterprise_project_id
String
参数解释：
企业项目ID。
取值范围：
- 0代表默认的企业项目。
- 对于非默认企业项目，值为具体企业项目ID。
actions
Array of strings
参数解释：
实例正在执行的任务。
取值范围：
不涉及。
- 正常响应样例
{ "instance_lts_configs": [ { "lts_configs": [ { "log_type": "audit_log", "lts_group_id": "b16d4ffd-915e-4a1b-93a8-51e3ced1091b", "lts_stream_id": "d107d52e-cbe0-4e31-a3c1-69560c231fb3", "enabled": false }, { "log_type": "error_log", "lts_group_id": "aca8ee04-78ff-48de-bab2-1d22532502fc", "lts_stream_id": "889a0244-a8d2-4936-8b60-eeb3ea4e6b0f", "enabled": true }, { "log_type": "slow_log", "lts_group_id": "aca8ee04-78ff-48de-bab2-1d22532502fc", "lts_stream_id": "f6b8fa5e-4842-4e72-b414-dd43985523e9", "enabled": false } ], "instance": { "id": "b5d77d54bb3f4e6abadb12047483c2e0in01", "name": "rds-45q9", "engine_name": "mysql", "engine_version": "8.0.43", "status": "normal", "enterprise_project_id": "0", "actions": [] } } ], "total_count": 1 } - 异常响应
请参见异常响应结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
