ModifySqlLogConfig - Database Autonomy Service - Alibaba Cloud Documentation Center

The ModifySqlLogConfig operation enables or configures Database Autonomy Service (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 DAS SDK.
When you use an SDK to call DAS, set the region to cn-shanghai.
By default, this operation enables the latest supported version. For more information about the databases and regions that are supported by different versions 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	The ID of the database instance.	rr-2ze770smbq3tp****
Enable	boolean	No	Specifies whether to enable DAS Enterprise Edition. Valid values: true false Note This parameter is required when you enable DAS Enterprise Edition. By default, the latest supported version is enabled.	true
RequestEnable	boolean	No	Specifies whether to enable the SQL Explorer feature. Valid values: true false Note This parameter is required only when you enable DAS Enterprise Edition V3.	true
Retention	integer	No	The total storage duration of data. Unit: days. Valid values: 7 30 180 365 Note If you enable DAS Enterprise Edition V3, set this parameter to a value greater than or equal to 30.	30
HotRetention	integer	No	The storage duration of hot data. Unit: days. The value must be an integer from 1 to 7. Note This parameter is required only when you enable DAS Enterprise Edition V3.	1
Filters	array<object>	No	A reserved parameter.
	object	No	A reserved parameter.
Key	string	No	A reserved parameter.	None
Value	string	No	A reserved parameter.	None
EnableAudit	boolean	No	Specifies whether to enable security audit.	true

DAS Enterprise Edition is available in V0, V1, V2, and V3. By default, the latest supported version is enabled.

For database instances that support only DAS Enterprise Edition V0, you only need to specify the Enable and Retention parameters.
For database instances that support DAS Enterprise Edition V1, you only need to specify the Enable and Retention parameters. The system automatically enables the SQL Explorer feature. In this case, the RequestEnable parameter is set to true by default.
For database instances that support DAS Enterprise Edition V2, you only need to specify the Enable and Retention parameters. The system automatically enables the SQL Explorer feature. In this case, the RequestEnable parameter is set to true by default. The storage duration of hot data (HotRetention) is fixed at 7 days, and the storage duration of cold data is Retention - 7 days.

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code that is returned.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	03C88D8E-1541-518E-8BFF-BEC6589B6334
Success	string	Indicates whether the request was successful. Valid values: true false	false
Data	object	The returned data.
SqlLogVisibleTime	integer	The time when DAS Enterprise Edition was enabled. The value is a UNIX timestamp. Unit: milliseconds.	1683712800000
RequestStopTime	integer	The time when DAS Enterprise Edition V1 expires. The value is a UNIX timestamp. Unit: milliseconds.	1715335200000
CollectorVersion	string	The version of the data collector. MYSQL_V0: MySQL V0. MYSQL_V1: MySQL V1. MYSQL_V2: MySQL V2. MYSQL_V3: MySQL V3. PG_V1: PostgreSQL V1. rdspg_v1: ApsaraDB RDS for PostgreSQL V1. polarpg_v1: PolarDB for PostgreSQL V1.	MYSQL_V3
SupportVersion	string	The latest version of DAS Enterprise Edition that is supported. 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: DAS Enterprise Edition is disabled. SQL_LOG_NOT_SUPPORT: DAS Enterprise Edition is not supported.	SQL_LOG_V3
ColdRetention	integer	The storage duration of cold data. Unit: days. This value is calculated using the following formula: `Retention - HotRetention`.	23
SqlLogEnable	boolean	Indicates whether DAS Enterprise Edition is enabled. true: Enabled. false: Disabled.	true
Retention	integer	The total storage duration of data. Unit: days.	30
HotRetention	integer	The storage duration of hot data. Unit: days.	7
RequestEnable	boolean	Indicates whether the SQL Explorer feature is enabled. true false	false
Version	string	The current version of DAS Enterprise Edition. 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: DAS Enterprise Edition is disabled. SQL_LOG_NOT_SUPPORT: DAS Enterprise Edition is not supported.	SQL_LOG_V3
RequestStartTime	integer	The time when the SQL Explorer feature was enabled. The value is a UNIX timestamp. Unit: milliseconds.	1683712800000
HotEnable	boolean	Indicates whether hot storage is enabled. true false	true
HotStartTime	integer	The time when hot storage was enabled. The value is a UNIX timestamp. Unit: milliseconds.	1683712800000
ColdEnable	boolean	Indicates whether cold storage is enabled. true false	true
ColdStartTime	integer	The time when cold storage was enabled. The value is a UNIX timestamp. Unit: milliseconds.	1683712800000
SqlLogState	string	The data migration state. Valid values: FINISH: The historical data is migrated. RUNNING: The historical data is being migrated. FAILURE: The historical data migration failed.	FINISH
LogFilter	string	A 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.