Enable or configure DAS Enterprise Edition by calling ModifySqlLogConfig - Database Autonomy Service

The ModifySqlLogConfig operation enables or configures DAS Enterprise Edition for a database instance.

Operation description

Before you call this operation, make sure that the following requirements are met:

Use the latest version of the Alibaba Cloud SDK or the DAS SDK.
When calling the DAS service with an SDK, set the region to `cn-shanghai`.
This operation enables the latest supported version by default. For more information about the databases and regions supported by each version of DAS Enterprise Edition, see DAS editions and supported features.

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:ModifySqlLogConfig

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	database instance ID.	rr-2ze770smbq3tp****
Enable	boolean	No	Enable DAS Enterprise Edition: true: Yes. false: No. Note Configure this parameter when you enable Enterprise Edition. By default, the latest supported version is enabled.	true
RequestEnable	boolean	No	Enable SQL insight. true: Yes. false: No. Note Configure this parameter only when you enable Enterprise Edition V3.	true
Retention	integer	No	Total storage duration in days. Valid values: 7 30 180 365 Note When you enable DAS Enterprise Edition V3, the value of this parameter must be greater than or equal to 30.	30
HotRetention	integer	No	Hot storage duration in days. Valid values are integers from 1 to 7. Note Configure this parameter only when you enable Enterprise Edition V3.	1
Filters	array<object>	No	Reserved parameter.
	object	No	Reserved parameter.
Key	string	No	Reserved parameter.	None
Value	string	No	Reserved parameter.	None
EnableAudit	boolean	No	Enable security audit.	true

DAS Enterprise Edition has four versions: V0, V1, V2, and V3. By default, the latest supported version is enabled.

For a database instance that supports only DAS Enterprise Edition V0, specify only the Enable and Retention parameters.
For a database instance that supports DAS Enterprise Edition V1, specify only the Enable and Retention parameters. The system automatically enables SQL Explorer (that is, RequestEnable defaults to true).
For a database instance that supports DAS Enterprise Edition V2, specify only the Enable and Retention parameters. The system automatically enables SQL Explorer (that is, RequestEnable defaults to true). The hot data storage duration (HotRetention) is fixed at 7 days, and the cold data storage duration is Retention - 7 days.

Response elements

Element	Type	Description	Example
	object
Code	string	The status code returned.	200
Message	string	The response message. Note If the request succeeds, this parameter returns Successful. If the request fails, it returns an error message such as an error code.	Successful
RequestId	string	The request ID.	03C88D8E-1541-518E-8BFF-BEC6589B6334
Success	string	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	false
Data	object	The returned data.
SqlLogVisibleTime	integer	The time when DAS Enterprise Edition was enabled. This value is a UNIX timestamp in milliseconds.	1683712800000
RequestStopTime	integer	The expiration time of DAS Enterprise Edition V1. This value is a UNIX timestamp in milliseconds.	1715335200000
CollectorVersion	string	The database collector version. MYSQL_V0: MySQL V0. MYSQL_V1: MySQL V1. MYSQL_V2: MySQL V2. MYSQL_V3: MySQL V3. PG_V1: PostgreSQL V1. rdspg_v1: RDS for PostgreSQL V1. polarpg_v1: PolarDB for PostgreSQL V1.	MYSQL_V3
SupportVersion	string	The latest supported DAS Enterprise Edition version. SQL_LOG_V0: Enterprise Edition V0. SQL_LOG_V1: Enterprise Edition V1. SQL_LOG_V2: Enterprise Edition V2. SQL_LOG_V3: Enterprise Edition V3. SQL_LOG_NOT_ENABLE: Enterprise Edition is disabled. SQL_LOG_NOT_SUPPORT: Enterprise Edition is not supported.	SQL_LOG_V3
ColdRetention	integer	The cold data storage duration, in days. This value is calculated as `Retention - HotRetention`.	23
SqlLogEnable	boolean	Indicates whether DAS Enterprise Edition is enabled. Valid values: true: Yes. false: No.	true
Retention	integer	The total data storage duration, in days.	30
HotRetention	integer	The hot data storage duration, in days.	7
RequestEnable	boolean	Indicates whether SQL Explorer is enabled. Valid values: true: Yes. false: No.	false
Version	string	The current DAS Enterprise Edition version. SQL_LOG_V0: Enterprise Edition V0. SQL_LOG_V1: Enterprise Edition V1. SQL_LOG_V2: Enterprise Edition V2. SQL_LOG_V3: Enterprise Edition V3. SQL_LOG_NOT_ENABLE: Enterprise Edition is disabled. SQL_LOG_NOT_SUPPORT: Enterprise Edition is not supported.	SQL_LOG_V3
RequestStartTime	integer	The time when SQL Explorer was enabled. This value is a UNIX timestamp in milliseconds.	1683712800000
HotEnable	boolean	Indicates whether hot data storage is enabled. Valid values: true: Yes. false: No.	true
HotStartTime	integer	The time when hot data storage was enabled. This value is a UNIX timestamp in milliseconds.	1683712800000
ColdEnable	boolean	Indicates whether cold data storage is enabled. Valid values: true: Yes. false: No.	true
ColdStartTime	integer	The time when cold data storage was enabled. This value is a UNIX timestamp in milliseconds.	1683712800000
SqlLogState	string	The status of historical data migration. Valid values: FINISH: Historical data migration is complete. RUNNING: Historical data migration is in progress. FAILURE: Historical data migration failed.	FINISH
LogFilter	string	Reserved parameter.	None
SqlLogSource	string

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "03C88D8E-1541-518E-8BFF-BEC6589B6334",
  "Success": "false",
  "Data": {
    "SqlLogVisibleTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "CollectorVersion": "MYSQL_V3",
    "SupportVersion": "SQL_LOG_V3",
    "ColdRetention": 23,
    "SqlLogEnable": true,
    "Retention": 30,
    "HotRetention": 7,
    "RequestEnable": false,
    "Version": "SQL_LOG_V3",
    "RequestStartTime": 1683712800000,
    "HotEnable": true,
    "HotStartTime": 1683712800000,
    "ColdEnable": true,
    "ColdStartTime": 1683712800000,
    "SqlLogState": "FINISH",
    "LogFilter": "None",
    "SqlLogSource": ""
  }
}

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.