Call DescribeSqlLogConfig to query DAS Enterprise Edition configurations - Database Autonomy Service

Queries the configurations of Database Autonomy Service (DAS) Enterprise Edition that is enabled for a database instance.

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or a DAS SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeSqlLogConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the database instance.	rm-2ze8g2am97624****

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	200
Data	object	The data that is returned.
ColdEnable	boolean	Indicates whether the cold data storage is enabled. Valid values: true false	true
ColdRetention	integer	The number of days for which the SQL Explorer and Audit data is stored in cold storage.	23
ColdStartTime	integer	The time when the cold data storage was enabled. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1683712800000
CollectorVersion	string	The collector version. Valid values: MYSQL_V0 MYSQL_V1 MYSQL_V2 MYSQL_V3 PG_V1 rdspg_v1 polarpg_v1	MYSQL_V3
HotEnable	boolean	Indicates whether the hot data storage is enabled. Valid values: true false	true
HotRetention	integer	The number of days for which the SQL Explorer and Audit data is stored in hot storage.	7
HotStartTime	integer	The time when the hot data storage was enabled. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1683712800000
LogFilter	string	A reserved parameter.	None
RequestEnable	boolean	Indicates whether the SQL Explorer feature is enabled. Valid values: true false	true
RequestStartTime	integer	The time when the SQL Explorer feature was enabled. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1683712800000
RequestStopTime	integer	The time when DAS Enterprise Edition V1 expired. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1715335200000
Retention	integer	The total storage duration of the SQL Explorer and Audit data. The value of this parameter is the sum of the values of HotRetention and ColdRetention. Unit: day.	30
SqlLogEnable	boolean	Indicates whether DAS Enterprise Edition is enabled. Valid values: true false	true
SqlLogSource	string	A reserved parameter.	None
SqlLogState	string	The state of data migration. Valid values: FINISH: The historical data is migrated. RUNNING: The historical data is being migrated. FAILURE: The historical data fails to be migrated.	FINISH
SqlLogVisibleTime	integer	The time when DAS Enterprise Edition was enabled. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1683712800000
SupportMigration	boolean	A reserved parameter.	None
SupportVersion	string	The latest version of DAS Enterprise Edition that supports the database instance. Valid values: SQL_LOG_V0: DAS Enterprise Edition V0. SQL_LOG_V1: DAS Enterprise version V1. SQL_LOG_V2: DAS Enterprise Edition V2. SQL_LOG_V3: DAS Enterprise Edition V3. SQL_LOG_NOT_ENABLE: DAS Enterprise Edition is not enabled. SQL_LOG_NOT_SUPPORT: DAS Enterprise Edition is not supported.	SQL_LOG_V3
Version	string	The version of DAS Enterprise Edition that is enabled for the database instance. Valid values: SQL_LOG_V0: DAS Enterprise Edition V0. SQL_LOG_V1: DAS Enterprise version V1. SQL_LOG_V2: DAS Enterprise Edition V2. SQL_LOG_V3: DAS Enterprise Edition V3. SQL_LOG_NOT_ENABLE: DAS Enterprise Edition is not enabled. SQL_LOG_NOT_SUPPORT: DAS Enterprise Edition is not supported.	SQL_LOG_V3
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message is returned.	Successful
RequestId	string	The request ID.	0A74B755-98B7-59DB-8724-1321B394****
Success	string	Indicates whether the request was successful. Valid values: true false	true

For database instances for which DAS Enterprise Edition V0 or DAS Enterprise Edition V1 is enabled, the SQL Explorer and Audit data is stored in CStore, which is considered as hot data storage.******** In this case, the following results are returned is the response: SqlLogEnable = HotEnable = true, Retention = HotRetention, ColdEnable = false, ColdRetention = 0.

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": {
    "ColdEnable": true,
    "ColdRetention": 23,
    "ColdStartTime": 1683712800000,
    "CollectorVersion": "MYSQL_V3",
    "HotEnable": true,
    "HotRetention": 7,
    "HotStartTime": 1683712800000,
    "LogFilter": "None",
    "RequestEnable": true,
    "RequestStartTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "Retention": 30,
    "SqlLogEnable": true,
    "SqlLogSource": "None",
    "SqlLogState": "FINISH",
    "SqlLogVisibleTime": 1683712800000,
    "SupportMigration": true,
    "SupportVersion": "SQL_LOG_V3",
    "Version": "SQL_LOG_V3"
  },
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.