# Alibaba Cloud Database Autonomy Service API

> Alibaba Cloud Database Autonomy Service API on Apizie: 116 endpoints (Calls the AddHDMInstance operation to connect a database instance to Database Autonomy Service (DAS), Invokes the asynchronous logic interface for DAS large model capabilities, Creates a cache analysis task by calling the CreateCacheAnalysisJob operation, You can call the CreateCloudBenchTasks operation to create a stress testing task, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-das/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-das`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/das
- Page: https://zieapi.vercel.app/api/cloud/aliyun-das
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-das/openapi.json

Alibaba Cloud OpenAPI for Database Autonomy Service (das, version 2020-01-16). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Calls the AddHDMInstance operation to connect a database instance to Database Autonomy Service (DAS)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/add-hdminstance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| __context | string | no | The reserved parameter |
| InstanceArea | string | yes | The database product to which the instance belongs. Valid values: RDS: cloud instance. ECS: self-managed instance on ECS. IDC:… |
| InstanceId | string | no | The instance ID |
| Ip | string | no | The internal endpoint of the instance to be connected |
| Port | string | no | The internal network connection port of the instance |
| Engine | string | no | The database engine. Valid values: MySQL PostgreSQL SQLServer PolarDBMySQL PolarDBPostgreSQL Redis MongoDB PolarDBOracle PolarDBX |
| Username | string | no | The username |
| Password | string | no | The password of the username |
| InstanceAlias | string | no | The instance name |
| NetworkType | string | no | The network type of the instance |
| VpcId | string | no | VPC ID |
| Region | string | no | The region in which the instance resides |
| FlushAccount | string | no | The reserved parameter |

### Invokes the asynchronous logic interface for DAS large model capabilities
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Message | string | no | The message |
| SessionId | string | no | Optional. The session ID, which is a UUID string. If not specified, a new session is created by default. The same session ID must be… |
| AgentId | string | no | Optional. The agent ID used for the service. You can specify the agent generated after enabling the DAS Agent or a manually created agent.… |
| Summary | string | no | Specifies whether to output summary information |
| Resume | string | no | The user interaction feedback |
| ForwardedProps | string | no | The forwarded properties |

### Creates a cache analysis task by calling the CreateCacheAnalysisJob operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-cache-analysis-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the Redis instance |
| NodeId | string | no | The ID of the data node in the instance. Specify this parameter to query monitoring information of a specific node. If you specify the… |
| BackupSetId | string | no | The ID of the backup file. You can call the https://help.aliyun.com/document_detail/473823.html operation to obtain the backup file ID. To… |
| Separators | string | no | The delimiters used to identify key prefixes. You do not need to specify this parameter if the default delimiters `:;,_-+@=/#` are used |

### You can call the CreateCloudBenchTasks operation to create a stress testing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-cloud-bench-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| TaskType | string | yes | The type of stress testing task. Valid values: pressure test (default): Intelligent stress testing, which replays the traffic captured… |
| SrcInstanceId | string | yes | The ID of the source instance. Only RDS MySQL and PolarDB MySQL instances are supported. You can call the… |
| Description | string | yes | The description of the stress testing task |
| SrcPublicIp | string | no | Reserved parameter |
| DstInstanceId | string | no | The ID of the target instance. Only RDS MySQL and PolarDB MySQL instances are supported. You can call the… |
| GatewayVpcId | string | no | The virtual private cloud (VPC) ID of the Database Gateway. This parameter is required when ClientType is set to ECS |
| GatewayVpcIp | string | no | The IP address or domain name of the Database Gateway. This parameter is required when ClientType is set to ECS |
| ClientType | string | yes | The type of stress testing machine. Valid values: ECS: You need to prepare a https://help.aliyun.com/document_detail/64905.html yourself.… |
| RequestStartTime | string | no | The start time of the stress testing task. The time is in the UNIX timestamp format. Unit: milliseconds |
| RequestEndTime | string | no | The end time of the stress testing task. The time is in the UNIX timestamp format. Unit: milliseconds |
| RequestDuration | string | no | The duration of the stress testing task. Unit: milliseconds |
| Rate | string | no | The replay speed of the source instance traffic on the target instance. The replay speed must be a positive integer. Valid values: 1 to… |
| SmartPressureTime | string | no | The duration of the generated stress testing. Unit: milliseconds. This parameter is required when TaskType is set to smart pressure test |
| DtsJobClass | string | no | The specification of the DTS migration task. You can call the https://help.aliyun.com/document_detail/230669.html operation to obtain the… |
| DtsJobId | string | no | The ID of the DTS migration task. You can call the https://help.aliyun.com/document_detail/208399.html operation to obtain the ID. This… |
| SrcSuperAccount | string | no | The privileged account of the source instance. Value: admin. This parameter is required when DstType is set to Instance |
| SrcSuperPassword | string | no | The password of the privileged account of the source instance. This parameter is required when DstType is set to Instance |
| DstSuperAccount | string | no | The privileged account of the target instance |
| DstSuperPassword | string | no | The password of the privileged account of the target instance |
| DstType | string | no | The type of the target instance. Valid values: Instance (default): instance ID. ConnectionString: connection address of the instance |
| DstConnectionString | string | no | The connection address of the target instance. Only RDS MySQL and PolarDB MySQL instances are supported. This parameter takes effect when… |
| DstPort | string | no | The port of the target instance. This parameter takes effect when DstType is set to ConnectionString |
| WorkDir | string | no | The temporary directory generated by the stress testing |
| BackupId | string | no | The ID of the backup set. You can call the https://help.aliyun.com/document_detail/26273.html operation to query the backup list and… |
| BackupTime | string | no | The time of the backup. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time) |
| Amount | string | no | The total number of stress testing tasks to create. Valid values: 0 to 30. Default value: 1 |
| EndState | string | no | The status after the stress testing task ends. Valid values: WAIT_TARGET: Prepare the target instance for stress testing. WAIT_DBGATEWAY:… |

### Creates a diagnostic report
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-diagnostic-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| StartTime | string | yes | The beginning of the time range to create the diagnostic report. This value is a UNIX timestamp representing the number of milliseconds… |
| EndTime | string | yes | The end of the time range to create the diagnostic report. This value is a UNIX timestamp representing the number of milliseconds that… |

### Calls the CreateKillInstanceSessionTask operation to create a task that terminates sessions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-kill-instance-session-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. For PolarDB for MySQL instances, provide the node ID. If no node ID is provided and the KillAllSessions request parameter is… |
| DbUser | string | yes | The database account that has the permission to terminate sessions |
| DbUserPassword | string | yes | The password of the database account |
| IgnoredUsers | string | no | The list of accounts whose sessions will not be terminated. The data is in JSONArray format, such as… |
| KillAllSessions | string | yes | Specifies whether to terminate all sessions. true: Yes. false: No. When this parameter is set to true, sessions of accounts specified in… |
| SessionIds | string | no | The list of session IDs to be terminated. The data is in JSONArray format, such as [SessionID1,SessionID2]. Separate multiple session IDs… |

### Creates a recent deadlock analysis task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-latest-dead-lock-analysis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. For PolarDB for MySQL instances, you must specify the node ID |

### Calls the CreateQueryOptimizeTag operation to add tags to target SQL statements
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-query-optimize-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL: RDS MySQL PolarDBMySQL: PolarDB for MySQL PostgreSQL: RDS PostgreSQL |
| SqlIds | string | yes | The SQL template ID. You can call the https://help.aliyun.com/document_detail/405261.html operation to query SQL template IDs. You can… |
| Tags | string | yes | The SQL tag. You can specify multiple values separated by commas (,). DAS_IMPORTANT: important SQL. DAS_NOT_IMPORTANT: unimportant SQL.… |
| Status | integer | yes | The status of the Tags request parameter. 0: Clears all tags for the SQL template IDs specified by SqlIds and ignores the Tags parameter.… |
| Comments | string | no | The remarks. The value must be 1 to 300 characters in length |
| InstanceId | string | yes | The instance ID |

### Initiates an SQL statement diagnostics request
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-request-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. This parameter must be specified for PolarDB for MySQL, PolarDB for PostgreSQL (Compatible with Oracle), and ApsaraDB for… |
| Database | string | yes | The name of the database |
| Sql | string | yes | The SQL statement that you want to diagnose |

### Creates a cross-service whitelist template for a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| RegionName | string | yes | The region ID |
| GlobalIgName | string | yes | The name of the IP whitelist template. The name must meet the following requirements: Contains only lowercase letters, digits, and… |
| GIpList | string | yes | The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). IP addresses cannot be duplicated. A maximum… |

### Creates an asynchronous task for detailed data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-sql-log-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | no | The database instance ID |
| NodeId | string | no | The node ID. This parameter is applicable only to cluster instances. You can specify this parameter to query the batch task of a specific… |
| Type | string | no | The task type. Export: export task. For the filter parameters and values supported by Export, see Request parameters description. Query:… |
| Name | string | no | The task name |
| Filters | string | no | The list of filter conditions (JSON-encoded) |
| StartTime | integer | yes | The start time of the task. Specify the value as a UNIX timestamp. Unit: milliseconds |
| EndTime | integer | yes | The end time of the task. Specify the value as a UNIX timestamp. Unit: milliseconds |
| Role | string | no | The node information of the PolarDB-X 2.0 database instance. polarx_cn: compute node. polarx_dn: data node |

### Creates a storage analysis task to query the usage details of one or more databases and tables
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/create-storage-analysis-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. For ApsaraDB for MongoDB instances, you can use this parameter to specify a node for storage analysis. You can call the… |
| DbName | string | no | The database name. If you specify a database, the operation analyzes the storage usage of the specified database |
| TableName | string | no | The table name. If you specify a table in the specified database, the operation analyzes the storage usage of the specified table. If you… |

### Deletes a stress testing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/delete-cloud-bench-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| TaskId | string | yes | The unique task ID. You can call the https://help.aliyun.com/document_detail/230670.html API to get this task ID |

### Deletes a cross-product whitelist template for a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/delete-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| RegionName | string | yes | The region ID |
| GlobalSecurityGroupId | string | yes | The ID of the IP whitelist template |

### Deletes the metadata of a stopped database gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/delete-stop-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| GatewayId | string | yes | The unique ID of the database gateway. Note: You can get this ID from the `ClientGatewayId` field in the response of the… |

### Queries the list of data audit alert logs to facilitate alert search and processing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-audit-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Lang | string | no | The language type of the request and response messages. Default value: zh_cn. Valid values: zh_cn: Chinese. en_us: English |
| UserName | string | no | The username |
| ClientIp | string | no | The IP address of the client that sends the request |
| ClientUa | string | no | The client type |
| InstanceName | string | no | The name of the asset instance |
| DatabaseName | string | no | The name of the database |
| StartTime | integer | no | The start time of the alert logs. Unit: milliseconds |
| EndTime | integer | no | The end time of the alert logs. The value is a UNIX timestamp in milliseconds |
| ProductCode | string | no | The name of the product to which the data asset belongs. Valid values include RDS, PolarDB, and PolarDB-X 2.0 |
| ProductId | integer | no | The ID of the product to which the data object belongs. Valid values: 3: ADB-MYSQL 5: RDS 7: PolarDB-X 8: PolarDB 9: ADB-PG 11: MongoDB… |
| SqlText | string | no | The content of the SQL statement |
| ExecuteTimeRange | string | no | The execution time range |
| EffectRowRange | string | no | The range of affected rows |
| RuleName | string | no | The name of the audit rule |
| OperateType | string | no | The operation type |
| OssObjectKey | string | no | The key of the OSS object |
| AsyncRequestId | string | no | The request ID |
| PageSize | integer | no | The maximum number of entries per page. Default value: 10 |
| CurrentPage | integer | no | The current page number |
| RuleCategory | string | no | The rule type |
| LoadWhiteList | string | no | Specifies whether to load the whitelist status |
| IpType | string | no | The network type. Valid values: default: Non-Alibaba Cloud services. This is the default value. aliyun: Alibaba Cloud services |
| LogSource | string | no | The data source |
| RuleAggQuery | string | no | Specifies whether to perform an aggregate query |
| RuleId | string | no | The rule ID |
| LogQueryOpJson | string | no | The LogQueryOpJson |

### Invokes the DescribeAutoScalingConfig operation to query the elastic scaling feature configuration of an…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-auto-scaling-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the elastic scaling history of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-auto-scaling-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID. Currently, only ApsaraDB RDS for MySQL instances are supported |
| AutoScalingTaskType | string | yes | The type of elastic scaling task to query. Currently, only SPEC is supported, which indicates querying the automatic performance scaling… |
| StartTime | integer | yes | The start time of the query task. Specify the value as a UNIX timestamp. Unit: milliseconds. The start time cannot be earlier than 45 days… |
| EndTime | integer | yes | The end time of the query task. Specify the value as a UNIX timestamp. Unit: milliseconds. The end time must be later than the start time |

### Returns details of a cache analysis task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-cache-analysis-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| JobId | string | yes | The ID of the cache analysis task. You can obtain the task ID from the response parameters of the… |

### Queries a list of cache analysis tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-cache-analysis-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| StartTime | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| PageNo | string | no | The page number. The value must be an integer that is greater than 0. Default value: 1 |
| PageSize | string | no | The number of entries per page. Default value: 10 |

### Queries the list of stress testing tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-cloud-bench-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Status | string | no | The running status of the task. Valid values: SUCCESS: Successful. IGNORED: Ignored. RUNNING: Running. EXCEPTION: Exception |
| TaskType | string | no | The type of the stress testing task. Valid values: pressure test (default): intelligent stress testing. Traffic captured from the target… |
| StartTime | string | no | The start time of the query task. Specify the value as a UNIX timestamp. Unit: milliseconds |
| EndTime | string | no | The end time of the query task. Specify the value as a UNIX timestamp. Unit: milliseconds. The end time of the query task must be later… |
| PageNo | string | no | The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. Default value: 1 |
| PageSize | string | no | The maximum number of records per page. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type.… |

### Queries a stress testing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-cloudbench-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| TaskId | string | yes | The task ID. You can call the https://help.aliyun.com/document_detail/230670.html operation to obtain the task ID |

### Retrieves the detailed configuration, file paths, and execution commands for a specific stress test task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-cloudbench-task-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| TaskId | string | yes | The unique ID of the stress test task. You can call the https://help.aliyun.com/document_detail/230670.html API to get the task ID |

### Queries the enabled items of Alibaba Cloud Managed Services
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-das-ops-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries diagnostics reports
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-diagnostic-report-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| DBInstanceId | string | yes | The instance ID |
| PageNo | string | no | The page number. The value must be a positive integer. Default value: 1 |
| PageSize | string | no | The number of entries per page. Default value: 10 |
| StartTime | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |

### Queries the error log details of an instance within a specified time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-error-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID |
| Role | string | no | The node role. Valid values: db mongos Only ApsaraDB for MongoDB instances are supported |
| StartTime | integer | yes | The start time of the query. The value is in the format of a UNIX timestamp, in milliseconds. The data type of this parameter is Long.… |
| EndTime | integer | yes | The end time of the query. The value is in the format of a UNIX timestamp, in milliseconds. The data type of this parameter is Long.… |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. Maximum value: 100 |
| Filters | string | no | The filter conditions. Only error log filtering for ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, PolarDB for MySQL, PolarDB for… |

### Calls the DescribeHotBigKeys operation to retrieve the hot keys and big keys in the current memory in real…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-hot-big-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID of the Redis instance |
| NodeId | string | no | The ID of the data shard in the Redis instance |

### Queries the hot keys of a Redis instance by calling the DescribeHotKeys operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-hot-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID of the Redis instance |
| NodeId | string | no | The ID of the data shard in the Redis instance |

### Queries whether Database Autonomy Service (DAS) Enterprise Edition V1 or V2 is enabled for a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-instance-das-pro` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |

### Queries the execution plan of an SQL statement
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-query-explain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The instance ID. For a PolarDB for MySQL instance, if a instance ID is specified, the execution plan is queried on the specified node.… |
| Sql | string | yes | The SQL statement for which to query the execution plan |
| DbName | string | no | The database name |
| Schema | string | no | The schema information. This is a reserved parameter |

### Displays the details of a cross-engine whitelist template for a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| RegionName | string | yes | The region ID |

### Displays the binding information between a cross-engine whitelist template and instances for a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-security-ipgroup-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| RegionName | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |

### Asynchronously retrieves the slow log trends data of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-slow-log-histogram-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |
| NodeId | string | no | The ID of the node. For a PolarDB for MySQL instance, you must specify the node ID |
| StartTime | integer | yes | The start time of the query task. Specify the time as a UNIX timestamp in milliseconds |
| EndTime | integer | yes | The end time of the query. Specify the time as a UNIX timestamp in milliseconds. The end time must be later than the start time |
| Filters | string | no | The list of query filter conditions (JSON-encoded) |

### Queries slow query log records of a database instance. You can filter and sort the results by multiple…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-slow-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID |
| StartTime | integer | yes | The start time |
| EndTime | integer | yes | The end time |
| PageNumber | integer | no | The page number. Pages start from page 1 |
| PageSize | integer | no | The number of entries per page |
| Filters | string | no | The list of filter conditions (JSON-encoded) |
| OrderBy | string | no | Common to all engines QueryTimeSeconds: query duration (seconds). Timestamp: timestamp. SQL-based engines (MySQL / PolarDB for MySQL /… |
| Asc | string | no | Specifies whether to sort the results in ascending order. Default value: true. true: Sort in ascending order. false: Sort in descending… |

### Retrieves slow query log statistics information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-slow-log-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. For ApsaraDB RDS for MySQL and PolarDB for MySQL, this parameter applies only to Cluster Edition instances. If you do not… |
| Type | string | no | The task type. Specific to SQL engines: SlowLogRequestOrigin: aggregates logs by source IP address. SlowLogRequestUser: aggregates logs by… |
| TemplateId | string | no | The template ID |
| StartTime | integer | yes | The start time of the query task. The time is a UNIX timestamp in UTC. Unit: milliseconds |
| EndTime | integer | yes | The end time of the query. The time is a UNIX timestamp in UTC. Unit: milliseconds |
| OrderBy | string | no | The sorting method. Valid values: Count QueryTime LockTime RowsExamined RowsSent |
| Asc | string | no | Specifies whether to sort the results in ascending order. Default value: false |
| PageNumber | integer | no | The page number. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The maximum number of entries per page. Default value: 10 |
| Filters | string | no | The list of query filter conditions (JSON-encoded) |

### Invokes the DescribeSqlInsightStatistic operation to perform aggregation of SQL Explorer statistics for a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-sql-insight-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The database instance ID. This operation supports ApsaraDB RDS for MySQL, PolarDB for MySQL, PolarDB-X, ApsaraDB RDS for PostgreSQL,… |
| NodeId | string | no | The ID of the node in the instance. This parameter is used to narrow the statistics scope to the specified node. Only a single node ID is… |
| Type | string | no | The aggregation or filter dimension for statistics. The value is not case-sensitive. If this parameter is not specified, the statistics… |
| TemplateId | string | no | The identifier of the statistics object. The meaning varies based on the value of Type. Valid values: When Type is set to SQL: specify the… |
| Keyword | string | no | The keywords used to retrieve SQL templates by fuzzy match based on the SQL template content. Separate multiple keywords with spaces. The… |
| StartTime | integer | yes | The start time of the query. The value is a UNIX timestamp in milliseconds. The system rounds down the value to the nearest minute. The… |
| EndTime | integer | yes | The end time of the query. The value is a UNIX timestamp in milliseconds. The system rounds up the value to the nearest minute. The time… |
| OrderBy | string | no | The field by which to sort the results. If this parameter is not specified or an unsupported value is specified, the results are sorted by… |
| Asc | string | no | The sort order. Default value: false (descending order). Valid values: true: ascending order. false: descending order |
| PageNo | integer | no | The page number. Pages start from page 1. If this parameter is not specified, the default value 1 is used |
| PageSize | integer | no | The number of statistical entries to return on each page. If this parameter is not specified, the default value 10 is used. The maximum… |
| DoFillTrend | string | no | Specifies whether to populate time series trend data for each statistical result, which corresponds to the Trend field in the response.… |
| SqlType | string | no | The SQL statement type used to filter the results. Valid values: select insert update delete The values must be in lowercase. In the… |
| DbName | string | no | The name of the database used to filter the results. In the aggregation storage links of some instances, you can specify multiple database… |
| Role | string | no | The role of the instance node. The value is not case-sensitive. If this parameter is not specified, the role is automatically parsed based… |
| JobId | string | no | The idempotent ID for querying SQL Explorer data. You do not need to specify this parameter for common queries |
| Filters | string | no | The list of structured filter conditions. The conditions are passed as key-value pairs. The POP format is Filters.N.Key and… |

### Queries the DAS Enterprise Edition configuration of a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-sql-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |

### Queries the log details of DAS Enterprise Edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-sql-log-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The ID of the database instance |
| NodeId | string | no | The node ID. For ApsaraDB RDS for MySQL and PolarDB for MySQL, this parameter applies only to Cluster Edition instances. If you do not… |
| Role | string | no | The role of the node in the PolarDB-X 2.0 instance. Valid values: polarx_cn: compute node. polarx_dn: data node |
| Filters | string | no | The list of filter conditions (JSON-encoded) |
| StartTime | integer | yes | The start time. The value is a UNIX timestamp in milliseconds |
| EndTime | integer | yes | The end time. The value is a UNIX timestamp in milliseconds |
| PageNo | integer | no | The page number for paging. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The maximum number of entries per page. Maximum value: 100. Default value: 10 |

### Invokes the DescribeSqlLogStatistic operation to query the statistics information of DAS Enterprise Edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-sql-log-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |

### Queries the details of a DAS Enterprise Edition batch task by calling the DescribeSqlLogTask operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-sql-log-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | no | The database instance ID |
| TaskId | string | no | The task ID |
| PageNo | integer | no | The page number for the paging query. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The maximum number of records per page for the paging query. Maximum value: 100. Default value: 10 |

### Queries the list of audit log tasks for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-sql-log-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | no | The database instance ID |
| NodeId | string | no | The node ID. This parameter is applicable only to Cluster Edition instances. You can specify a node to query its batch tasks. If you do… |
| Filters | string | no | The list of query filter conditions (JSON-encoded) |
| StartTime | integer | no | The start time of the query. Specify a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time of the query. Specify a UNIX timestamp in milliseconds |
| PageNo | integer | no | The page number for the paging query. Pages start from 1. Default value: 1 |
| PageSize | integer | no | The maximum number of records per page. Maximum value: 100. Default value: 10 |

### Queries the top 100 large keys over a period of time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-top-big-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The ID of the ApsaraDB for Redis instance |
| NodeId | string | no | The ID of the data shard on the ApsaraDB for Redis instance |
| StartTime | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |

### Queries the top 100 hot keys within a specified time period
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/describe-top-hot-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | A reserved parameter |
| InstanceId | string | yes | The ID of the Redis instance |
| NodeId | string | no | The ID of the data shard of the Redis instance |
| StartTime | string | yes | The start of the query time range, specified as a UNIX timestamp in milliseconds |
| EndTime | string | yes | The end of the query time range, specified as a UNIX timestamp in milliseconds. The end time must be later than the start time. You can… |

### Disables all throttling rules that are in effect
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/disable-all-sql-concurrency-control-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID. You must specify this parameter only if your database instance is an ApsaraDB RDS for MySQL instance or a PolarDB for… |

### Disables the automatic tablespace fragment recycling feature for database instances at a time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/disable-auto-resource-optimize-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceIds | string | yes | The database instance ID. Set this parameter to a JSON array that consists of multiple instance IDs. Separate instance IDs with commas… |

### Disables the automatic SQL throttling feature for multiple database instances at a time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/disable-auto-throttle-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceIds | string | yes | The database instance IDs. Set this parameter to a JSON array that consists of multiple instance IDs. Separate instance IDs with commas… |

### Deactivates Database Autonomy Service (DAS) Professional Edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/disable-das-pro` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| UserId | string | no | The ID of the Alibaba Cloud account that is used to create the database instance. This parameter is optional. The system can automatically… |
| InstanceId | string | yes | The database instance ID |

### Disables the auto scaling feature for a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/disable-instance-das-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |
| Engine | string | yes | The database engine. Set the value to Redis |
| ScaleType | string | yes | The type of auto scaling. Valid values: specScale: The specifications of a database instance are automatically scaled up or down.… |

### Disables a throttling rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/disable-sql-concurrency-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID. The database instance must be an ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster |
| ItemId | integer | yes | The ID of the throttling rule that is applied to the instance. You can call the https://help.aliyun.com/document_detail/223538.html… |

### Enables DAS Professional Edition for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/enable-das-pro` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| UserId | string | no | The instance ID, which is the ID of the Alibaba Cloud account that created the database instance. This parameter is optional. After you… |
| InstanceId | string | yes | The instance ID of the database |
| SqlRetention | integer | no | The storage duration of SQL Explorer data. Unit: days. Default value: 30. Valid values: 30 180 365 1095 1825 |

### Enables SQL throttling to control the numbers of database access requests and concurrent SQL statements
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/enable-sql-concurrency-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID. You must specify the instance ID only if your database instance is an ApsaraDB RDS for MySQL instance or a PolarDB for… |
| SqlType | string | yes | The type of the SQL statements. Valid values: SELECT UPDATE DELETE |
| MaxConcurrency | integer | yes | The maximum number of concurrent SQL statements. Set this parameter to a positive integer. When the number of concurrent SQL statements… |
| SqlKeywords | string | yes | The keywords that are used to identify the SQL statements that need to be throttled. If you specify multiple SQL keywords, separate them… |
| ConcurrencyControlTime | integer | yes | The duration within which the SQL throttling rule takes effect. Unit: seconds. The throttling rule takes effect only within this duration |

### Asynchronously queries the IDs of SQL statements that generate a MySQL error code in the SQL Explorer…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-async-error-request-list-by-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. This parameter must be specified if the database instance is a PolarDB for MySQL cluster |
| Start | integer | no | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| End | integer | no | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| ErrorCode | string | no | The error code. You can call the https://help.aliyun.com/document_detail/409804.html operation to query the MySQL error codes that may be… |

### Asynchronously queries the MySQL error codes in SQL Explorer data and the number of SQL queries…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-async-error-request-stat-by-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. This parameter must be specified for PolarDB for MySQL clusters |
| Start | integer | no | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| End | integer | no | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| DbName | string | no | The name of a database |

### Call GetAsyncErrorRequestStatResult to asynchronously get the execution error count for a specific SQL…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-async-error-request-stat-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| NodeId | string | no | The ID of the node. This parameter is required for PolarDB for MySQL instances |
| SqlIdList | string | no | One or more SQL IDs. Separate multiple SQL IDs with commas. You can call the https://help.aliyun.com/document_detail/410746.html operation… |
| Start | integer | no | The start time of the query, specified as a Unix timestamp in milliseconds. The start time must be within the data retention period of SQL… |
| End | integer | no | The end time of the query, specified as a Unix timestamp in milliseconds. The end time must be later than the start time. The interval… |
| DbName | string | no | The name of the database |

### Queries the usage of auto-increment table IDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-auto-increment-usage-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| DbNames | string | no | The database name. If you specify a database, the operation queries the usage of auto-increment table IDs in the specified database.… |
| RatioFilter | number | yes | The usage threshold of auto-increment IDs. Only usage that exceeds the threshold can be returned. Valid values are decimals that range… |
| RealTime | string | yes | Specifies whether to query real-time data. Valid values: true: queries data in real time except for data generated in the last 10… |

### Queries the automatic fragment recycling rules of database instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-auto-resource-optimize-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceIds | string | no | The database instance IDs. Specify the parameter value as a JSON array, such as `['Database account 1','Database account 2']`. Separate… |

### Queries the automatic SQL throttling rules of a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-auto-throttle-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceIds | string | no | The database instance IDs. Set this parameter to a JSON array that consists of multiple instance IDs. Separate instance IDs with commas… |

### Returns details of autonomous notification events for a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-autonomous-notify-event-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| __context | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID |
| SpanId | string | yes | The unique identifier of the event. You can call the https://help.aliyun.com/document_detail/288371.html operation to query the unique… |

### Queries the notification events of one or more urgency levels within a period
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-autonomous-notify-events-in-range` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| __context | string | no | The reserved parameter |
| InstanceId | string | no | The instance ID |
| StartTime | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| NodeId | string | no | The ID of the node in a PolarDB for MySQL cluster. You can call the https://help.aliyun.com/document_detail/98094.html operation to query… |
| EventContext | string | no | The reserved parameter |
| Level | string | no | The urgency level of the events. If you specify this parameter, the MinLevel parameter does not take effect. Valid values: Notice: events… |
| MinLevel | string | no | The minimum urgency level of the events. Valid values: Notice: events for which the system sends notifications. Optimization: events that… |
| PageOffset | string | no | The page number. The value must be a positive integer. Default value: 1 |
| PageSize | string | no | The number of entries per page |

### Queries the blocking data of an ApsaraDB RDS for SQL Server instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-blocking-detail-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The ID of the database instance |
| StartTime | string | yes | The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| PageNo | string | no | The page number. The value must be an integer that is greater than 0. Default value: 1 |
| PageSize | string | no | The number of entries per page. The value must be an integer that is greater than 0. Default value: 10 |
| QueryHash | string | no | The hash value of the SQL statement. The hash values of SQL statements of the same type are the same |
| DbNameList | string | no | The name of the database. Separate multiple database names with commas (,) |

### Retrieves the network connectivity diagnosis result from a user-specified IP address to a specified database…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-dbinstance-connectivity-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| SrcIp | string | yes | The source IP address |

### Provides a DAS large model interactive SSE interface. Supports features such as AI chat and performance…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-das-agent-sse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Query | string | yes | The natural language description for the query |
| InstanceId | string | no | Deprecated parameter. The instance ID is passed through the Query field |
| SessionId | string | no | Optional. The session ID in UUID string format. If not specified, a new session is created. To maintain context across conversations, use… |
| AgentId | string | no | Optional. By default, the default agent is used. You can also specify an agent that was generated after enabling the DAS Agent service or… |

### Queries the storage usage of DAS Enterprise Edition V1 or V2 for a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-das-pro-service-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| UserId | string | no | The user ID, which is the ID of the Alibaba Cloud account that is used to create the database instance. This parameter is optional. If you… |
| InstanceId | string | yes | The database instance ID |

### Retrieves the hot data of audit logs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-das-sqllog-hot-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |
| Start | integer | yes | The start time of the query. The time is in the UNIX timestamp format. Unit: milliseconds. You can only query data generated after DAS… |
| End | integer | yes | The end time of the query. The time is in the UNIX timestamp format. Unit: milliseconds. The end time must be later than the start time,… |
| QueryKeyword | string | no | The keyword. Fuzzy match is supported. You can use a maximum of 10 keywords for a combined query. Separate multiple keywords with spaces.… |
| AccountName | string | no | The database account. You can use multiple database accounts for a combined query. Separate multiple database accounts with spaces.… |
| DBName | string | no | The database name. You can use multiple database names for a combined query. Separate multiple database names with spaces. Example: `DB1… |
| HostAddress | string | no | The IP address of the client. You can use multiple client IP addresses for a combined query. Separate multiple client IP addresses with… |
| LogicalOperator | string | no | The logical relationship between multiple keywords. Valid values: or: OR. and: AND |
| MaxLatancy | integer | no | The maximum execution duration. Unit: microseconds. This parameter is used to query SQL statements whose execution duration is less than… |
| MaxScanRows | integer | no | The maximum number of scanned rows. This parameter is used to query SQL statements whose number of scanned rows is less than the specified… |
| MinLatancy | integer | no | The minimum execution duration. Unit: microseconds. This parameter is used to query SQL statements whose execution duration is greater… |
| MinScanRows | integer | no | The minimum number of scanned rows. This parameter is used to query SQL statements whose number of scanned rows is greater than or equal… |
| SqlType | string | no | The type of the SQL statement. Valid values: select update delete |
| State | string | no | The execution result. If you enter 0, the system queries SQL statements that are successfully executed. You can also enter a specific… |
| ThreadID | string | no | The thread ID. You can use multiple thread IDs for a combined query. Separate multiple thread IDs with spaces. Example: `ThreadID1… |
| PageNumbers | integer | no | The page number for the paging query. Pages start from 1. Default value: 1 |
| MaxRecordsPerPage | integer | no | The maximum number of records per page for the paging query. Valid values: 5 to 100 |
| SortKey | string | no | The sort key. Valid values: ScanRows: the number of scanned rows. UpdateRows: the number of updated rows. Consume: the execution duration.… |
| SortMethod | string | no | The sort order. Valid values: ASC: ascending order. DESC: descending order |
| ChildDBInstanceIDs | string | no | The node ID. For a PolarDB for MySQL instance, you must specify the node ID |
| Role | string | no | The reserved parameter. This parameter is not supported |
| TraceId | string | no | The reserved parameter. This parameter is not supported |
| MinRows | integer | no | The reserved parameter. This parameter is not supported |
| MaxRows | integer | no | The reserved parameter. This parameter is not supported |
| MinSpillCnt | integer | no | The reserved parameter. This parameter is not supported |
| MaxSpillCnt | integer | no | The reserved parameter. This parameter is not supported |
| TransactionId | string | no | The transaction ID |
| Fail | string | no | The error code returned when the SQL statement is executed. You can call the https://help.aliyun.com/document_detail/409804.html operation… |

### Retrieves the detailed information for a single deadlock event
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-dead-lock-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The ID of the database instance |
| NodeId | string | no | The node ID. Required for PolarDB for MySQL cluster instances |
| TextId | string | yes | The ID of the deadlock text. This value is returned from the GetDeadLockHistory operation |
| Source | string | no | The source of the analysis task: MANUAL or not specified: queries the recent deadlock analysis task. AUTO: queries the full deadlock… |

### Queries the deadlock details of an ApsaraDB RDS for SQL Server instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-dead-lock-detail-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The ID of the database instance |
| StartTime | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| PageNo | string | no | The page number. The value must be an integer that is greater than 0. Default value: 1 |
| PageSize | string | no | The number of entries per page. Default value: 10 |
| DbNameList | string | no | The name of the database. When you specify multiple databases, you must separate the database names with commas (,) |

### Retrieves the historical analysis tasks for recent and full deadlock analysis
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-dead-lock-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. Specify the node ID for a PolarDB for MySQL instance |
| PageNo | integer | no | The page number |
| PageSize | integer | no | The number of entries per page. The maximum value is 100 |
| StartTime | integer | yes | The start time of the query. This value is a UNIX timestamp. Unit: milliseconds. This parameter is a Long value. To prevent precision loss… |
| EndTime | integer | yes | The end time of the query. This value is a UNIX timestamp. Unit: milliseconds. This parameter is a Long value. To prevent precision loss… |
| Source | string | no | The source of the task: MANUAL or unspecified: queries tasks for recent deadlock analysis. AUTO: queries tasks for full deadlock analysis.… |

### Queries the trend of deadlock counts based on full deadlock analysis of error logs within a specified time…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-deadlock-histogram` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. For a PolarDB for MySQL instance, you must specify the node ID |
| StartTime | integer | yes | The start time of the query. The format is a UNIX timestamp in milliseconds. The start time cannot be more than 7 days earlier than the… |
| EndTime | integer | yes | The end time of the query. The format is a UNIX timestamp in milliseconds. This field is of the Long type. Precision loss may occur during… |
| Status | string | no | The analysis status of the task |

### Asynchronously queries information about failed SQL queries in SQL Explorer data. You can query up to 20…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-error-request-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. You must specify the node ID if your database instance is a PolarDB for MySQL cluster |
| SqlId | string | no | The SQL query ID. You can call the https://help.aliyun.com/document_detail/410746.html operation to query the ID of the SQL query for… |
| Start | integer | no | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| End | integer | no | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| DbName | string | no | The name of the database |

### Queries the event subscription settings of a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Collects the full request statistics in the SQL Explorer results of a database instance by access source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-full-request-origin-stat-by-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| UserId | string | no | The ID of the Alibaba Cloud account that is used to create the database instance. This parameter is optional. The system can automatically… |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. This parameter must be specified if the database instance is a PolarDB for MySQL cluster |
| Start | integer | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| End | integer | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| OrderBy | string | no | The field by which the results to be returned are sorted. Default value: count. Valid values: count: the number of executions. avgRt: the… |
| Asc | string | no | Specifies whether to sort the results in ascending order. By default, the results are not sorted in ascending order |
| PageNo | integer | yes | The page number. Pages start from page 1. Default value: 1 |
| PageSize | integer | yes | The number of entries per page. Default value: 20 |
| SqlType | string | no | The type of the SQL statement. Valid values: SELECT, INSERT, UPDATE, DELETE, MERGE, ALTER, CREATEINDEX, DROPINDEX, CREATE, DROP, SET,… |
| Role | string | no | The role of the PolarDB-X 2.0 node. Valid values: polarx_cn: compute node. polarx_en: data node |

### Queries SQL sample data from the SQL Explorer results of a database instance by SQL ID by calling the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-full-request-sample-by-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| SqlId | string | yes | SQL ID |
| Start | integer | yes | The beginning of the time range to query. Specify a UNIX timestamp in milliseconds. The start time must be within the storage duration of… |
| End | integer | yes | The end of the time range to query. Specify a UNIX timestamp in milliseconds. The end time must be later than the start time, and the… |
| Role | string | no | The node information of a PolarDB-X 2.0 database instance. polarx_cn: compute node. polarx_en: data node |

### Asynchronously aggregates the full request data in the SQL Explorer results of a database instance by SQL ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-full-request-stat-result-by-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| UserId | string | no | The instance ID, which is the ID of the Alibaba Cloud account that created the database instance. This parameter is optional. After you… |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. For PolarDB for MySQL instances, the node ID is required |
| SqlId | string | no | The SQL ID. If you specify an SQL ID, the full request data of the specified SQL ID is aggregated. If you leave this parameter empty, the… |
| OriginHost | string | no | The IP address of the client that executed the SQL statement. This parameter is optional. If you specify a client IP address, the full… |
| Keyword | string | no | The query keyword |
| Start | integer | yes | The start time of the query. The format is a UNIX timestamp, in milliseconds. The start time must be within the SQL Explorer storage… |
| End | integer | yes | The end time of the query. The time is a UNIX timestamp in milliseconds. The end time must be later than the start time, and the interval… |
| OrderBy | string | no | The field by which to sort the results. Default value: count. count: the number of executions. avgRt: the average execution time. rtRate:… |
| Asc | string | no | Specifies whether to sort the results in ascending order. Default value: false |
| PageNo | integer | yes | The page number for the paged query. The paging starts from 1. Default value: 1 |
| PageSize | integer | yes | The data volume per page for paging in a paged query. Default value: 20 |
| SqlType | string | no | The type of the SQL statement. Valid values: SELECT, INSERT, UPDATE, DELETE, LOGIN, LOGOUT, MERGE, ALTER, CREATEINDEX, DROPINDEX, CREATE,… |
| DbName | string | no | The name of the database |
| Role | string | no | The node information of the PolarDB-X 2.0 database instance. Valid values: polarx_cn: compute node. polarx_dn: data node |

### Retrieves the details of a DAS Agent automated operations report
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-instance-group-inspect-report-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ReportId | string | yes | The ID of the operations report |
| AgentId | string | no | The ID of the agent that the user purchased |
| ReportType | string | no | The type of the report |

### Queries the list of O&M reports generated by DAS Agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-instance-group-inspect-report-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| GroupId | string | no | The reserved parameter |
| AgentId | string | no | Optional. The default agent is used by default. Alternatively, you can specify an agent that was generated after DAS Agent was activated… |
| StartTime | integer | yes | The start time of the query, which is a UNIX timestamp in milliseconds |
| EndTime | integer | yes | The end time of the query, which is a UNIX timestamp in milliseconds |
| ReportType | string | no | The type of the inspection report |

### Queries the result of an inspection that is performed on a database instance by using the inspection and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-instance-inspections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL Redis PolarDBMySQL |
| StartTime | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| PageNo | string | yes | The page number. The value must be a positive integer. Default value: 1 |
| PageSize | string | yes | The number of entries per page. Default value: 10 |
| InstanceArea | string | yes | The type of the instance on which the database is deployed. Valid values: RDS: an Alibaba Cloud database instance. ECS: an ECS instance on… |
| SearchMap | string | no | The filter condition, which can be specified in one of the following formats: Specify the ID of a single instance in the… |
| ResourceGroupId | string | no | The resource group ID |

### Returns details of all missing indexes for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-instance-missing-index-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID. Only ApsaraDB RDS for SQL Server instances are supported |
| PageNo | string | no | The page number. Pages start from page 1. Default value: 1 |
| PageSize | string | no | The number of entries per page. Default value: 10 |
| ObjectName | string | no | The object name |
| ReservedSize | string | no | The query condition based on the table size |
| RowCount | string | no | The query condition based on the number of table rows |
| ReservedPages | string | no | The query condition based on the total number of pages |
| IndexCount | string | no | The query condition based on the number of indexes |
| UniqueCompiles | string | no | The query condition based on the number of compilations |
| UserSeeks | string | no | The query condition based on the number of seeks |
| UserScans | string | no | The query condition based on the number of scans |
| AvgTotalUserCost | string | no | The query condition based on the average cost savings |
| AvgUserImpact | string | no | The query condition based on the performance improvement |
| StartTime | string | no | The start time of the last seek |
| EndTime | string | no | The end time of the last seek |

### Queries statistics on automatic SQL optimization events within a period of time, such as the total number of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-instance-sql-optimize-statistic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID. The database instance must be an ApsaraDB RDS for MySQL instance or a PolarDB for MySQL cluster |
| StartTime | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| NodeId | string | no | The node ID. For ApsaraDB RDS for MySQL Cluster Edition instances or PolarDB for MySQL clusters, you must specify the node ID |
| Threshold | string | no | The duration threshold for automatic SQL optimization events. After this parameter is specified, the system collects statistics on… |
| FilterEnable | string | no | Specifies whether to filter instances for which DAS Enterprise Edition is enabled. Valid values: true false If you set this parameter to… |
| UseMerging | string | no | Specifies whether to merge automatic SQL optimization events. Valid values: true: merges automatic SQL optimization events. false: does… |

### Queries the results of a task that terminates sessions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-kill-instance-session-task-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. You must specify this parameter if your database instance is a PolarDB for MySQL cluster |
| TaskId | string | yes | The task ID. You can obtain the task ID from the response parameters of the https://help.aliyun.com/document_detail/609246.html operation |

### Queries the current sessions of an ApsaraDB for MongoDB (MongoDB) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-mongo-dbcurrent-op` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. If you do not specify a node ID, the sessions of the primary node are queried by default |
| Role | string | no | A reserved parameter. You do not need to specify the parameter |
| FilterDoc | string | no | The `db.currentOp()` command that is used to filter sessions. For more information, see db.currentOp()… |

### Asynchronously queries the sessions of an instance and collects statistics on the sessions based on dimensions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-my-sqlall-session-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID. Only ApsaraDB RDS for MySQL, PolarDB for MySQL, and PolarDB-X 2.0 instances are supported |
| NodeId | string | no | The node ID. You must specify this parameter for PolarDB for MySQL clusters. If you do not specify a node ID, the session data of the… |
| ResultId | string | no | The asynchronous request ID. GetMySQLAllSessionAsync is an asynchronous operation. After a request is sent, the system does not return… |

### Queries access frequency statistics and hot data on partitions of a PolarDB-X 2.0 instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-partitions-heatmap` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | no | The instance ID |
| TimeRange | string | no | The time range to be queried. Valid values: LAST_ONE_HOURS: the last hour. LAST_SIX_HOURS: the last six hours. LAST_ONE_DAYS: the last… |
| Type | string | no | The type of the data to be queried. Valid values: READ_ROWS: the read rows. WRITTEN_ROWS: the written rows. READ_WRITTEN_ROWS: the read… |

### Queries the trend of a metric for the new version of the performance insight feature of a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-pfs-metric-trends` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| NodeId | string | no | The node ID. This parameter is required if the database instance is an ApsaraDB RDS for MySQL Cluster Edition instance or a PolarDB for… |
| Metric | string | no | The metric whose trend you want to query. Valid values: count: the number of executions. avgRt: the average execution duration. rtRate:… |
| StartTime | integer | no | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | integer | no | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |

### Retrieves the SQL sample data for the Performance Insight (New Version) feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-pfs-sql-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID. Only ApsaraDB RDS for MySQL and PolarDB for MySQL instances are supported |
| NodeId | string | no | The node ID. For an ApsaraDB RDS for MySQL Cluster Edition instance or a PolarDB for MySQL cluster, you must specify the node ID |
| SqlId | string | no | The SQL ID |
| StartTime | integer | yes | The start time of the query. The time is a UNIX timestamp in milliseconds |
| EndTime | integer | yes | The end time of the query. The time is a UNIX timestamp in milliseconds. The end time must be later than the start time. You can query… |

### Call the GetPfsSqlSummaries API to query all request data using the SQL ID dimension in Performance Insight…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-pfs-sql-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | no | Database instance ID |
| NodeId | string | no | Node ID. Provide a node ID for RDS MySQL Cluster Edition or PolarDB for MySQL database instances |
| SqlId | string | no | SQL ID. If you specify an SQL ID, the system returns statistics for that SQL ID only. If you leave this parameter empty, the system… |
| Keywords | string | no | Keywords in the SQL text. Separate multiple keywords with spaces |
| StartTime | integer | no | Start time of the query, in Unix timestamp format, in milliseconds |
| EndTime | integer | no | End time of the query, in Unix timestamp format, in milliseconds. The end time must be later than the start time. You can query data for… |
| OrderBy | string | no | Field to sort by. Default is count. count: Number of executions. avgLatency: Average execution time. rowsExamined: Total number of scanned… |
| Asc | string | no | Sort in ascending order. Default is false. true: Yes. false: No |
| PageNo | integer | no | Page number for paged queries. Start from 1. Default is 1 |
| PageSize | integer | no | Maximum number of records per page for paged queries. Default is 10. Maximum is 100 |

### Returns SQL template statistics from query governance data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-data-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL |
| InstanceIds | string | no | The instance IDs. Separate multiple IDs with commas (,) |
| TagNames | string | no | The reserved parameter |
| Keywords | string | no | The keywords of the SQL template. Separate multiple keywords with spaces |
| LogicalOperator | string | no | The logical relationship between multiple keywords. Valid values: or and |
| Rules | string | no | The tags that are used to filter SQL templates. Separate multiple tags with commas (,). For more information, see… |
| DbNames | string | no | The name of the database to be queried |
| Time | string | yes | The time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds |
| PageSize | string | no | The number of entries per page. Default value: 10 |
| PageNo | string | no | The page number. Pages start from page 1. Default value: 1 |
| OrderBy | string | no | The field by which to sort the returned entries. Default value: count. Valid values: count: the number of executions. maxQueryTime: the… |
| Asc | string | no | Specifies whether to sort the returned entries in ascending order. Default value: true. Valid values: true: sorts the returned entries in… |
| OnlyOptimizedSql | string | no | Specifies whether to query only SQL templates that need to be optimized. Default value: false. Valid values: true: queries only SQL… |
| SqlIds | string | no | The SQL template ID. You can query the ID of a template by calling the https://help.aliyun.com/document_detail/405235.html operation |
| Region | string | no | The region in which the instance resides. Valid values: cn-china: Chinese mainland cn-hongkong: China (Hong Kong) ap-southeast-1:… |
| User | string | no | The account of the database to be queried |

### Returns the best- and worst-performing instances based on query governance data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-data-top` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL |
| InstanceIds | string | no | The instance IDs. Separate multiple IDs with commas (,) |
| TagNames | string | no | The reserved parameter |
| Time | string | yes | The time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1,… |
| Type | string | yes | The type of instances that you want to query. Valid values: RED: the best-performing instances BLACK: the worst-performing instances |
| Region | string | no | The region in which the instance resides. Valid values: cn-china: Chinese mainland cn-hongkong: China (Hong Kong) ap-southeast-1:… |

### Queries query governance trend data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-data-trend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL |
| InstanceIds | string | no | The instance IDs. Separate multiple IDs with commas (,) |
| TagNames | string | no | The reserved parameter |
| Start | string | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| End | string | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |
| Region | string | no | The region in which the instance resides. Valid values: cn-china: Chinese mainland. cn-hongkong: China (Hong Kong). ap-southeast-1:… |

### Queries the failed SQL statements under a SQL template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-exec-error-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL |
| InstanceId | string | yes | The instance ID |
| SqlId | string | yes | The SQL template ID. You can call the https://help.aliyun.com/document_detail/405235.html operation to obtain the SQL template ID |
| Time | string | yes | The date to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970,… |

### Queries SQL templates that failed to be executed
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-exec-error-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL |
| InstanceIds | string | no | The instance IDs. Separate multiple IDs with commas (,) |
| Keywords | string | no | The keywords of the SQL template. Separate multiple keywords with spaces |
| LogicalOperator | string | no | The logical relationship between multiple keywords. Valid values: or and |
| DbNames | string | no | The name of the database to be queried |
| Time | string | yes | The time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds |
| PageSize | string | yes | The number of entries per page. Default value: 10 |
| PageNo | string | yes | The page number. Pages start from page 1. Default value: 1 |
| OrderBy | string | no | The field by which to sort the returned entries. Only error_count is supported, which specifies that the entries are sorted based on the… |
| Asc | string | no | Specifies whether to sort the returned entries in ascending order. Default value: true. Valid values: true: sorts the returned entries in… |
| Region | string | no | The region in which the instance resides. Valid values: cn-china: Chinese mainland cn-hongkong: China (Hong Kong) ap-southeast-1:… |

### Queries the tags added by the query governance feature to specified database instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-rule-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL |
| InstanceIds | string | no | The instance IDs. Separate multiple IDs with commas (,) |
| TagNames | string | no | A reserved parameter |
| Region | string | no | The region in which the instance resides. Valid values: cn-china: Chinese mainland cn-hongkong: China (Hong Kong) ap-southeast-1:… |

### Retrieves the share URL for Query Governance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-share-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL: RDS MySQL PolarDBMySQL: PolarDB for MySQL PostgreSQL: RDS PostgreSQL |
| InstanceIds | string | no | The instance IDs. Separate multiple instance IDs with commas |
| TagNames | string | no | The reserved parameter |
| Keywords | string | no | The keywords in the SQL text. Separate multiple keywords with spaces |
| LogicalOperator | string | no | The logical relationship between multiple keywords in the SQL text. Valid values: or: The OR logical relationship. and: The AND logical… |
| Rules | string | no | The rules to be filtered. Separate multiple rules with commas. For more information, see https://help.aliyun.com/document_detail/290038.html |
| DbNames | string | no | The names of the databases to be queried |
| Time | integer | yes | The date when the data is queried. The value is a UNIX timestamp in milliseconds |
| PageSize | integer | no | The maximum number of records per page in a paging query. Default value: 10 |
| PageNo | integer | no | The page number of the paging query. Pages start from 1. Default value: 1 |
| OrderBy | string | no | The field by which to sort the results. Default value: count. Valid values: count: The number of executions. maxQueryTime: The maximum… |
| Asc | string | no | Specifies whether to sort the results in ascending order. Default value: true. Valid values: true: Yes. false: No |
| OnlyOptimizedSql | string | no | Specifies whether to query only the SQL statements that need to be optimized. Default value: false. Valid values: true: Yes. false: No |
| SqlIds | string | no | The SQL template IDs. You can call the https://help.aliyun.com/document_detail/405261.html operation to query the SQL template IDs |
| Region | string | no | The region where the instance resides. Valid values: cn-china: The Chinese mainland. cn-hongkong: Hong Kong (China). ap-southeast-1:… |
| User | string | no | The database account to be queried |

### Queries suggestions provided by query governance for optimizing an SQL template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-solution` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL |
| SqlId | string | yes | The SQL template ID. You can call the https://help.aliyun.com/document_detail/405261.html operation to query the SQL template ID |
| RuleIds | string | yes | The tag ID. For more information, see https://help.aliyun.com/document_detail/290038.html |
| InstanceId | string | no | The instance ID. You can call the https://help.aliyun.com/document_detail/405261.html operation to query the instance ID |

### Queries the tags of a specified SQL statement by calling the GetQueryOptimizeTag operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-query-optimize-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Engine | string | yes | The database engine. Valid values: MySQL: RDS MySQL PolarDBMySQL: PolarDB for MySQL PostgreSQL: RDS PostgreSQL |
| SqlId | string | yes | The SQL template ID. You can call the https://help.aliyun.com/document_detail/405261.html operation to query the SQL template ID |
| InstanceId | string | yes | The instance ID |

### Queries the current session on an ApsaraDB for Redis instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-redis-all-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The database instance ID |

### Queries SQL diagnostics records by pages
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-request-diagnosis-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. You must specify the node ID if your database instance is a PolarDB for MySQL, PolarDB for PostgreSQL (Compatible with… |
| PageNo | integer | yes | The page number. The value must be a positive integer. Default value: 1 |
| PageSize | integer | yes | The number of entries per page. The value must be a positive integer. Default value: 10 |
| StartTime | integer | yes | The beginning of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed… |
| EndTime | integer | yes | The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since… |

### Call GetRequestDiagnosisResult to retrieve the SQL diagnosis results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-request-diagnosis-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. This parameter is required for cluster instances such as PolarDB for MySQL, PolarDB for PostgreSQL (Oracle-compatible), and… |
| MessageId | string | yes | The unique diagnosis ID returned by the https://help.aliyun.com/document_detail/341609.html operation. If `MessageId` is the diagnosis ID… |
| SqlId | string | no | The SQL template ID. This parameter is for internal use by the DAS console. You do not need to specify this parameter |
| Source | string | no | The source of the task. This parameter is for internal use by the DAS console. You do not need to specify this parameter |

### Queries the throttling rules that are in effect
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-running-sql-concurrency-control-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID. You must specify this parameter only if your database instance is an ApsaraDB RDS for MySQL instance or a PolarDB for… |
| PageNo | integer | no | The page number. The value must be a positive integer. Default value: 1 |
| PageSize | integer | no | The number of entries per page. The value must be a positive integer. Default value: 10 |

### Generates a throttling keyword string based on an SQL statement
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-sql-concurrency-control-keywords-from-sql-text` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID |
| SqlText | string | yes | The SQL statement based on which a throttling keyword string is to be generated |

### Queries the throttling rules that are being executed or have been triggered
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-sql-concurrency-control-rules-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID. Only ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters are supported |
| PageNo | integer | no | The page number. The value must be an integer that is greater than 0. Default value: 1 |
| PageSize | integer | no | The number of entries per page. The value must be an integer that is greater than 0. Default value: 10 |

### Queries the diagnostic suggestions generated by the DAS automatic SQL optimization feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-sql-optimize-advice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | A reserved parameter |
| Engine | string | no | The database engine. Valid values: MySQL: RDS MySQL. PolarDBMySQL: PolarDB for MySQL |
| InstanceIds | string | no | The instance ID. Only RDS MySQL and PolarDB for MySQL instances are supported |
| StartDt | string | no | The start date of the query. Format: yyyyMMdd (UTC). If this parameter is left empty, the default value is the day before the current… |
| EndDt | string | no | The end date of the query. Format: yyyyMMdd (UTC). If this parameter is left empty, the default value is the day before the current date.… |
| Region | string | no | The region to which the instance belongs. Valid values: cn-china: the Chinese mainland. cn-hongkong: Hong Kong (China). ap-southeast-1:… |

### Queries the status and results of a storage analysis task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-storage-analysis-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NodeId | string | no | The node ID. This parameter is reserved |
| TaskId | string | yes | The task ID. You can obtain the task ID from the response of the https://help.aliyun.com/document_detail/2639140.html operation |

### Invokes the ApsaraDB Agent large language model API to perform tasks such as knowledge Q&A and performance…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/get-yao-chi-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Query | string | yes | The natural language description of the query |
| SessionId | string | no | Optional. The session ID, which is a UUID string. If this parameter is not specified, a new session is created. To maintain context in a… |
| Source | string | no | Optional. The source cloud service. Specifies the cloud service to which the Q&A belongs. Default value: yaochi |
| ExtraInfo | string | no | Optional. The additional information, which is a JSON string |
| ImageKeys | string | no | The ImageKeys |

### Calls the KillInstanceAllSession operation to terminate all sessions on a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/kill-instance-all-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceId | string | yes | The instance ID |

### Modifies the elastic scaling configuration of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/modify-auto-scaling-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Spec | string | no | The configuration items for the specification elastic scaling feature (JSON-encoded) |
| Storage | string | no | The configuration items for the automatic storage expansion feature (JSON-encoded) |
| Bandwidth | string | no | The configuration items for the bandwidth elastic scaling feature (JSON-encoded) |
| Shard | string | no | The configuration items for the shard elastic scaling feature (JSON-encoded) |
| Resource | string | no | The configuration items for the resource elastic scaling feature (JSON-encoded) |

### Modifies the configuration items of Alibaba Cloud Managed Services
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/modify-das-ops-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |
| Enable | string | no | Specifies whether to enable DAS Alibaba Cloud Managed Services. Valid values: true: Enabled. false: Disabled. Note that shutdown only… |
| Filters | string | no | The reserved parameter (JSON-encoded) |

### Modifies the audit forwarding configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/modify-forward-sql-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The database instance ID |
| Service | string | yes | The service type. Valid values: DAS_OPS: enables top key delivery |
| Source | string | yes | The source of the task. Valid values: TOP_KEY: enables top key delivery |
| Enable | string | yes | Specifies whether to enable the feature. Valid values: true: yes. false: no |

### Modifies a cross-product whitelist template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/modify-security-ipgroup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| RegionName | string | yes | The region ID |
| GlobalIgName | string | yes | The name of the IP address whitelist template. The name must meet the following requirements: It can contain lowercase letters, digits,… |
| GIpList | string | yes | The IP addresses in the whitelist template. Separate multiple IP addresses with commas (,). A maximum of 1,000 IP addresses or CIDR blocks… |
| GlobalSecurityGroupId | string | yes | The ID of the IP address whitelist template |

### Attaches or detaches a cross-engine whitelist template to or from a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/modify-security-ipgroup-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| RegionName | string | yes | The region ID |
| InstanceId | string | yes | The database instance ID |
| GlobalSecurityGroupId | string | yes | The ID of the IP whitelist template |

### Enables or configures DAS Enterprise Edition for a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/modify-sql-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The ID of the database instance |
| Enable | string | no | Specifies whether to enable DAS Enterprise Edition. Valid values: true: Yes. false: No. This parameter is required when you enable DAS… |
| RequestEnable | string | no | Specifies whether to enable SQL Explorer. Valid values: true: Yes. false: No. This parameter is required only when you enable DAS… |
| Retention | integer | no | The total data storage duration. Unit: days. Valid values: 7 30 180 365 When you enable DAS Enterprise Edition V3, the value of this… |
| HotRetention | integer | no | The hot data storage duration. Unit: days. The value is an integer in the range of [1, 7]. This parameter is required only when you enable… |
| Filters | string | no | A reserved parameter (JSON-encoded) |
| EnableAudit | string | no | Specifies whether to enable security auditing |

### Calls the RunCloudBenchTask operation to execute a stress testing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/run-cloud-bench-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| TaskId | string | yes | The ID of the stress testing task. You can call the https://help.aliyun.com/document_detail/230670.html operation to obtain the task ID |

### Configures the event subscription settings for a database instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/set-event-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| EventContext | string | no | The supported event scenarios. You can set the value to AllContext, which indicates that all scenarios are supported |
| Lang | string | no | The language of event notifications. You can set the value to zh-CN, which indicates that event notifications are sent in Chinese |
| MinInterval | string | no | The minimum interval between consecutive event notifications. Unit: seconds |
| ContactName | string | no | The name of the contact who receives alert notifications. Separate multiple names with commas (,) |
| ChannelType | string | no | The notification method. Valid values: hdm_alarm_sms: text message. dingtalk: DingTalk chatbot. hdm_alarm_sms_and_email: text message and… |
| ContactGroupName | string | no | The name of the contact group that receives alert notifications. Separate multiple names with commas (,) |
| Level | string | no | The risk level of the events. Valid values: Notice: events that trigger notifications, including events at the Notice, Optimization, Warn,… |
| Active | string | no | Specifies whether to enable the event subscription feature. Valid values: 0: disables the event subscription feature. 1: enables the event… |
| Severity | string | no | The alert severity based on the event type. Specify this parameter in the following format: `{"Event type 1":"Alert severity", "Event type… |
| DispatchRule | string | no | The notification rules based on the event type. If you leave this parameter empty, the values of MinInterval and ChannelType prevail.… |

### Asynchronously configures parameters related to the automatic fragment recycling feature for multiple…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/update-auto-resource-optimize-rules-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | The reserved parameter |
| InstanceIds | string | yes | The database instance IDs. Set this parameter to a JSON array that consists of multiple instance IDs. Separate instance IDs with commas… |
| TableSpaceSize | number | yes | The minimum storage usage that triggers automatic fragment recycling of a single physical table. Valid values: 5 to 100. Unit: GB |
| TableFragmentationRatio | number | yes | The fragmentation rate that triggers automatic fragment recycling of a single physical table. Valid values: 0.10 to 0.99 |
| ResultId | string | no | The ID of the asynchronous request. Asynchronous calls do not immediately return the complete results. To obtain the complete results, you… |

### Enables, modifies, or disables the automatic SQL optimization feature for multiple database instances at a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/update-auto-sql-optimize-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| Instances | string | yes | The database instance IDs. Separate multiple IDs with commas (,). You can specify up to 50 instance IDs |
| Status | integer | yes | The status of the automatic SQL optimization feature. Valid values: 0: The automatic SQL optimization feature is disabled. 1: SQL… |

### Calls the UpdateAutoThrottleRulesAsync operation to asynchronously configure automatic SQL throttling…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/update-auto-throttle-rules-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |
| ConsoleContext | string | no | A reserved parameter |
| InstanceIds | string | yes | The database instance IDs. The data format is JSONArray, such as `['Instance ID 1','Instance ID 2']`. Separate instance IDs with commas (,) |
| CpuUsage | number | yes | The CPU utilization threshold. Valid values: 70% to 100% |
| CpuSessionRelation | string | yes | The logical relationship between the CPU utilization threshold and the active sessions threshold. Valid values: AND: both conditions must… |
| ActiveSessions | integer | yes | The active sessions threshold. If the relationship with the CPU utilization threshold is OR, the value must be greater than or equal to… |
| AbnormalDuration | number | yes | The duration threshold of the anomaly that triggers automatic SQL throttling. The value must be a positive integer greater than or equal… |
| MaxThrottleTime | number | yes | The maximum throttling duration. The value must be a positive integer. Unit: minutes |
| AllowThrottleStartTime | string | yes | The start time of the throttling time window (UTC) |
| AllowThrottleEndTime | string | yes | The end time of the throttling time window (UTC) |
| AutoKillSession | string | yes | Specifies whether to simultaneously kill abnormal SQL statements that are being executed. Abnormal SQL statements are those that match the… |
| ResultId | string | no | The ID of the asynchronous request. An asynchronous call does not immediately return complete results. First, call this operation to… |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-das/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://das.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-das/add-hdminstance" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Database Autonomy Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-das/add-hdminstance with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Database Autonomy Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Database Autonomy Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Database Autonomy Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-das.

### What is the status of the Alibaba Cloud Database Autonomy Service API?
Needs your own provider key (bring your own key)