Querying the Configurations for Ingesting Instance Logs to LTS (RDS for MySQL)

Function

This API is used to query the configurations for ingesting instance logs to LTS.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rds:instance:listAll	read	-	-	rds:instance:list	-

URI

URI format
GET /v3/{project_id}/{engine}/instances/logs/lts-configs

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	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	Definition Instance engine to be queried. Constraints Only the MySQL engine is supported. Range mysql Default Value N/A
enterprise_project_id	No	Definition Enterprise project ID. Constraints N/A Range N/A Default Value N/A
instance_id	No	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
instance_name	No	Definition Instance name. Constraints N/A Range N/A Default Value N/A
sort	No	Definition Sorting. Constraints N/A Range N/A Default Value N/A
instance_status	No	Definition Instance status. Constraints N/A Range N/A Default Value N/A
offset	No	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints N/A Range The value must be a non-negative number. Default Value 0: The query starts from the first data record.
limit	No	Definition Number of records on each page. Constraints N/A Range 1–100 Default Value 10

Request

None

Example Request

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/mysql/instances/logs/lts-configs

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
instance_lts_configs	Array of objects	Definition List of LTS log configurations. For details, see Table 3.
total_count	int	Definition Total records. Range N/A

**Table 3** instance_lts_configs field data structure description
Parameter	Type	Description
lts_configs	Array of objects	Definition LTS configurations. Range N/A
instance	String	Definition Instance details. Range N/A
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
engine_version	String	Definition DB engine version. Range N/A
status	String	Definition Instance status. Range N/A
enterprise_project_id	String	Definition Enterprise project ID. Range N/A
actions	Array of objects	Definition Ongoing actions. Range N/A

Example normal response

{
    "instance_lts_configs": [
        {
            "lts_configs": [],
            "instance": {
                "id": "982b8d01b15640b0aa02a2b9e0f89e60in01",
                "name": "rds-cluster-lc",
                "engine_name": "mysql",
                "engine_version": "5.7.43",
                "status": "creating",
                "enterprise_project_id": "0",
                "actions": ["OPEN_AUDIT_LOG"]
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "718c99c761cf425bb12836acee2ee96bin01",
                "name": "AUTO-GENERATED-INSTANCE-80-HA-CLOUDSSD",
                "engine_name": "mysql",
                "engine_version": "8.0.28",
                "status": "creating",
                "enterprise_project_id": "0",
                "actions": []
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "8474c4f9180f4dc29ab031549f699c15in01",
                "name": "rds-1464",
                "engine_name": "mysql",
                "engine_version": "5.6.51",
                "status": "creating",
                "enterprise_project_id": "0",
                "actions": []
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "11e48d5de3bc4b24977b1c786a77dffdin01",
                "name": "mysql_57_cluster_2u4g_1_XUHjS77NByzm6i9SyAsUSu",
                "engine_name": "mysql",
                "engine_version": "5.7.43",
                "status": "normal",
                "enterprise_project_id": "0",
                "actions": []
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "1d944c00cbdb4a8a8697f8d3e9c50280in01",
                "name": "mxk-rds-replica",
                "engine_name": "mysql",
                "engine_version": "5.7.43",
                "status": "normal",
                "enterprise_project_id": "0",
                "actions": []
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "8831ab590f7447cc81961bc74ccbe6cfin01",
                "name": "AUTO-GENERATED-INSTANCE-57-HA-CLOUDSSD",
                "engine_name": "mysql",
                "engine_version": "5.7.43",
                "status": "normal",
                "enterprise_project_id": "0",
                "actions": []
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "8c2e52430bdd4b118b9d84bb5906cab4in01",
                "name": "mysql_57_cluster_2u4g_1_Bv3Yzor6oxF5iyWAmag4Rk",
                "engine_name": "mysql",
                "engine_version": "5.7.43",
                "status": "normal",
                "enterprise_project_id": "0",
                "actions": [
                    "RESIZE_FLAVOR"
                ]
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "280540a1029e43cf9c20383b6a280e4fin01",
                "name": "AUTO-GENERATED-INSTANCE-80-HA-CLOUDSSD",
                "engine_name": "mysql",
                "engine_version": "8.0.28",
                "status": "normal",
                "enterprise_project_id": "0",
                "actions": []
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "ce44d253fb5743628a3cb2d830d2a675in01",
                "name": "rds-d5b2",
                "engine_name": "mysql",
                "engine_version": "8.0.28",
                "status": "normal",
                "enterprise_project_id": "0",
                "actions": []
            }
        },
        {
            "lts_configs": [],
            "instance": {
                "id": "7ebca04957b44c04afbaff2702057d45in01",
                "name": "rds-bb76-mdl",
                "engine_name": "mysql",
                "engine_version": "5.7.43",
                "status": "normal",
                "enterprise_project_id": "0",
                "actions": []
            }
        }
    ],
    "total_count": 14
}