ModifySqlLogConfig - Database Autonomy Service - Alibaba Cloud Documentation Center

Enables or configures DAS Enterprise Edition for a database instance.

Operation description

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.
Enable	boolean	No	Specifies whether to enable DAS Enterprise Edition. true: Enables DAS Enterprise Edition. false: Disables DAS Enterprise Edition. Note This parameter is required to enable DAS Enterprise Edition. By default, the latest supported version is enabled.
RequestEnable	boolean	No	Specifies whether to enable SQL Explorer. true: Enables SQL Explorer. false: Disables SQL Explorer. Note This parameter is required only if you enable DAS Enterprise Edition V3.
Retention	integer	No	The total data storage duration, in days. Valid values: 7 30 180 365 Note If you enable DAS Enterprise Edition V3, set this parameter to 30 or greater.
HotRetention	integer	No	The storage duration for hot data, in days. Valid values are integers from 1 to 7. Note This parameter is required only if you enable DAS Enterprise Edition V3.
Filters	array<object>	No	This parameter is reserved.
	object	No	This parameter is reserved.
Key	string	No	This parameter is reserved.
Value	string	No	This parameter is reserved.
EnableAudit	boolean	No	Specifies whether to enable security audit.

Response elements

Element	Type	Description	Example
	object
Code	string	The status code returned.
Message	string	The response message. Note If the request is successful, Successful is returned. If the request fails, an error message is returned.
RequestId	string	The ID of the request.
Success	string	Indicates whether the request was successful. true: The request succeeded. false: The request failed.
Data	object	The data returned.
SqlLogVisibleTime	integer	The time when DAS Enterprise Edition was enabled. This is a UNIX timestamp in milliseconds.
RequestStopTime	integer	The expiration time of DAS Enterprise Edition V1. This is a UNIX timestamp in milliseconds.
CollectorVersion	string	The version of the Database 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.
SupportVersion	string	The latest supported 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: Enterprise Edition is disabled. SQL_LOG_NOT_SUPPORT: Enterprise Edition is not supported.
ColdRetention	integer	The storage duration for cold data, in days. This value is calculated using the formula: `Retention - HotRetention`.
SqlLogEnable	boolean	Indicates whether DAS Enterprise Edition is enabled. true: Enabled. false: Disabled.
Retention	integer	The total data storage duration, in days.
HotRetention	integer	The storage duration for hot data, in days.
RequestEnable	boolean	Indicates whether SQL Explorer is enabled. true: Enabled. false: Disabled.
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: Enterprise Edition is disabled. SQL_LOG_NOT_SUPPORT: Enterprise Edition is not supported.
RequestStartTime	integer	The time when SQL Explorer was enabled. This is a UNIX timestamp in milliseconds.
HotEnable	boolean	Indicates whether hot data storage is enabled. true: Enabled. false: Disabled.
HotStartTime	integer	The time when hot data storage was enabled. This is a UNIX timestamp in milliseconds.
ColdEnable	boolean	Indicates whether cold data storage is enabled. true: Enabled. false: Disabled.
ColdStartTime	integer	The time when cold data storage was enabled. This is a UNIX timestamp in milliseconds.
SqlLogState	string	The data migration status. FINISH: The historical data is migrated. RUNNING: The historical data is being migrated. FAILURE: The historical data migration failed.
LogFilter	string	This parameter is reserved.
SqlLogSource	string

Examples

Success response

JSON format

{
  "Code": "",
  "Message": "",
  "RequestId": "",
  "Success": "",
  "Data": {
    "SqlLogVisibleTime": 0,
    "RequestStopTime": 0,
    "CollectorVersion": "",
    "SupportVersion": "",
    "ColdRetention": 0,
    "SqlLogEnable": true,
    "Retention": 0,
    "HotRetention": 0,
    "RequestEnable": true,
    "Version": "",
    "RequestStartTime": 0,
    "HotEnable": true,
    "HotStartTime": 0,
    "ColdEnable": true,
    "ColdStartTime": 0,
    "SqlLogState": "",
    "LogFilter": "",
    "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.