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.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
hdm:DescribeSqlLogConfig | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the database instance. | rm-2ze8g2am97624**** |
Response parameters
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
Sample success responses
JSON
format
{
"Code": "200",
"Message": "Successful",
"RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
"Success": "true",
"Data": {
"SqlLogVisibleTime": 1683712800000,
"CollectorVersion": "MYSQL_V3",
"SupportVersion": "SQL_LOG_V3",
"ColdRetention": 23,
"SqlLogEnable": true,
"Retention": 30,
"HotRetention": 7,
"RequestEnable": true,
"Version": "SQL_LOG_V3",
"RequestStartTime": 1683712800000,
"HotEnable": true,
"HotStartTime": 1683712800000,
"ColdEnable": true,
"ColdStartTime": 1683712800000,
"SqlLogState": "FINISH",
"RequestStopTime": 1715335200000,
"LogFilter": "None",
"SupportMigration": true,
"SqlLogSource": ""
}
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | InvalidParams | The request parameters are invalid. |
403 | NoPermission | You are not authorized to do this action. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-07-23 | The Error code has changed. The response structure of the API has changed | View Change Details |