查询LTS配置列表
调试
您可以在API Explorer中调试该接口。
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条数据，表示从第一条数据开始查询。
limit
否
Integer
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
不能为负数，最小值为1，最大值为100。
默认取值：
100
instance_name
否
String
参数解释：
实例名称，按照实例名称过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
否
String
参数解释：
实例ID，按照实例ID过滤。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
无。
请求示例
GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/sqlserver/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
参数解释：
日志类型。
取值范围：
不涉及。
lts_group_id
String
参数解释：
LTS日志组ID。
取值范围：
不涉及。
lts_stream_id
String
参数解释：
LTS日志流ID。
取值范围：
不涉及。
enabled
Boolean
参数解释：
LTS配置是否开启。
取值范围：
不涉及。
表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代表默认的企业项目。
actions
Array of strings
参数解释：
实例正在执行的任务。
取值范围：
不涉及。
- 正常响应样例
{ "total_count" : 1, "instance_lts_configs" : [ { "lts_configs" : [ { "log_type" : "error_log", "lts_group_id" : "7598ae98-d2de-4bed-b1e8-26b380b3fc37", "lts_stream_id" : "8eec64c0-bd23-4ada-8147-76e57b10e63b", "enabled" : true } ], "instance" : { "id" : "2ed8f3de95fb47928326bf73dd4fb02din04", "name" : "rds-9f31", "engine_name" : "sqlserver", "engine_version" : "2019_SE", "engine_category" : "", "status" : "ACTIVE", "enterprise_project_id" : 0, "actions" : [ "BACKUP" ] } } ] } - 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
