Docs

Database Workshop

SQL insights and auditing

CreateFullSqlOrder

Call the CreateFullSqlOrder API to create a full SQL subscription order for the specified instance.

Request type

Synchronous request

Request parameters

Name	Type	Is it required?	Sample	Description
FollowInstanceID	String	Yes	mysql-cf8d83******	Instance ID. tip You can select the following APIs to query the instance ID as needed: Call the DescribeDBInstances API to query the instance ID of RDS for MySQL. Call the DescribeDBInstances API to query the instance ID of veDB MySQL. Call the DescribeDBInstances API to query the instance ID of RDS for PostgreSQL.
InstanceType	String	Yes	MySQL	Database types. The following database types are supported: MySQL: RDS for MySQL. VeDBMySQL: veDB for MySQL. Postgres: RDS for PostgreSQL.
Ttl	Integer	Yes	30	The total number of days to retain Full SQL data. The value is the sum of the HotStorageDays and ColdStorageDays parameters.
LogProductType	String	Yes	FullSqlLog	The source type of the log. Valid values: FullSqlLog: Full SQL log. ProxyFullSqlLog: Proxy full SQL log.
RegionId	String	Yes	cn-beijing	Region ID.
CustomStorageSqlMethods	Array of string	Yes	[ "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE", "DROP", "RENAME", "TRUNCATE", "OTHER" ]	SQL types that are collected and stored. Values include: SELECT, INSERT, UPDATE, DELETE, ALTER, CREATE, DROP, RENAME, TRUNCATE, OTHER.
LabelType	String	Yes	ConsumeTls	Deployment tag type, currently only supports ConsumeTls values.
DefaultCloseType	String	No	CloseAuditCollectAndTls	Close method. Currently, only the CloseAuditCollectAndTls value is supported.
Tags	Array of TagObject	No	[ { "Key": "env", "Value": "prod" } ]	Tags are used to mark resources to facilitate searching and resource aggregation.
EnableFunctions	RegionEnableFunctions	No	{ "SQLAuditDetail": true, "SQLInsight": true, "EnableHierarchicalStorage": true }	Function switches supported in the current region.
HotStorageDays	Integer	No	7	Standard storage days. The value range is 1 to 1095.
ColdStorageDays	Integer	No	23	Infrequent-access retention period, ranging from 30 to 3648 days. Default value: 30.

Response parameters

Name	Type	Sample	Description
AuditServiceID	String	DBW_FullSql_66****-39e1-4139-a785-501a9d****	Full SQL service instance ID.
OrderID	String	Order2001000022227******	Billing order ID.

Request example

POST /?Action=CreateFullSqlOrder&Version=2018-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: dbw.volcengineapi.com​
X-Date: 20210328T100802Z​
Authorization: HMAC-SHA256 Credential=AKLTYmYwNjAzYjFmMjRkNDQwZWI4MzI1MzhjZGYyM******/20210328/cn-beijing/dbw/request, SignedHeaders=x-date, Signature=e1d274292f8b36eb096e1d2fec02822bd2e5cb3435699938adb7341861******​
​
{​
    "FollowInstanceID": "mysql-cf8d83******",​
    "InstanceType": "MySQL",​
    "RegionId": "cn-beijing",​
    "Ttl": 31,​
    "LabelType": "ConsumeTls",​
    "DefaultCloseType": "CloseAuditCollectAndTls",​
    "LogProductType": "FullSqlLog",​
    "CustomStorageSqlMethods": [​
        "SELECT",​
        "INSERT",​
        "UPDATE",​
        "DELETE",​
        "ALTER",​
        "CREATE",​
        "DROP",​
        "RENAME",​
        "TRUNCATE",​
        "OTHER"​
    ],​
    "Tags": [​
        {​
            "Key": "dbw_auto_team",​
            "Value": "qa"​
        }​
    ],​
    "EnableFunctions": {​
        "SQLAuditDetail": true,​
        "SQLInsight": true,​
        "EnableHierarchicalStorage": true​
    },​
    "HotStorageDays": 1,​
    "ColdStorageDays": 30​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "20260824144406F0D34313ECD148E4432A-d95d25",​
        "Action": "CreateFullSqlOrder",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "AuditServiceID": "DBW_FullSql_66******-39e1-4139-a785-501a9d******",​
        "OrderID": "Order2001000022227******"​
    }​
}​

Error code

For details, refer to Error codes.

Last updated: 2026.09.01 16:59:33