Querying LTS Configurations
Function
This API is used to query LTS configurations.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
URI
- URI format
GET /v3/{project_id}/{engine}/instances/logs/lts-configs?offset={offset}&limit={limit}&instance_name={instance_name}&instance_id={instance_id}
- Parameter description
Table 1 Parameters Parameter
Mandatory
Type
Description
project_id
Yes
String
Definition
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
engine
Yes
String
Definition
DB engine type.
Constraints
N/A
Range
mysql, postgresql, and sqlserver, which are case insensitive.
Default Value
N/A
offset
No
Integer
Definition
Index offset.
Constraints
N/A
Range
The query starts from the next piece of data indexed by this parameter. The value must be a number and cannot be a negative number.
Default Value
0: The query starts from the first data record.
limit
No
Integer
Definition
Number of records returned by a query.
Constraints
N/A
Range
The value must be a positive integer ranging from 1 to 100.
Default Value
100
instance_name
No
String
Definition
Instance name, which can be used for filtering.
Constraints
N/A
Range
N/A
Default Value
N/A
instance_id
No
String
Definition
Instance ID, which can be used for filtering.
Constraints
N/A
Range
N/A
Default Value
N/A
Request
None
Example Request
GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/sqlserver/instances/logs/lts-configs
Response
- Normal response
Table 2 Parameters Parameter
Type
Description
total_count
Integer
Definition
Total number of results.
Range
N/A
instance_lts_configs
Array of objects
Definition
Instance LTS configuration list. For details, see Table 3.
Table 3 instance_lts_configs field description Parameter
Type
Description
lts_configs
Array of objects
Definition
LTS configuration details. For details, see Table 4.
instance
object
Definition
Instance details. For details, see Table 5.
Table 4 lts_configs field description Parameter
Type
Description
log_type
String
Definition
Log type.
Range
N/A
lts_group_id
String
Definition
LTS log group ID.
Range
N/A
lts_stream_id
String
Definition
LTS log stream ID.
Range
N/A
enabled
Boolean
Definition
Whether to enable log reporting to LTS.
Range
N/A
Table 5 instance field description Parameter
Type
Description
id
String
Definition
Instance ID.
Range
N/A
name
String
Definition
Instance name.
Range
N/A
engine_name
String
Definition
DB engine name.
Range
N/A
status
String
Definition
Instance status.
Range
- creating: The instance is being created.
- createfail: The instance failed to be created.
- normal: The instance is normal.
- abnormal: The instance is abnormal.
- data_disk_full: The instance storage is full.
- deleted: The instance has been deleted.
- shutdown: The instance is stopped.
enterprise_project_id
String
Definition
Enterprise project ID.
Range
0: default enterprise project
actions
Array of strings
Definition
Task that is being executed on the instance.
Range
N/A
- Example normal response
{ "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", "status" : "ACTIVE", "enterprise_project_id" : 0, "actions" : [ "BACKUP" ] }, "total_count" : 1 } ] }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot