You need to enable JavaScript to run this app.
文档中心
数据库工作台

数据库工作台

复制全文
下载 pdf
SQL 洞察与审计
CreateFullSqlOrder
复制全文
下载 pdf
CreateFullSqlOrder
调用 CreateFullSqlOrder 接口为指定实例创建全量 SQL 订阅订单。​
请求类型​
同步请求。​
请求参数​
​
名称​
类型​
是否必选​
示例值​
描述​
FollowInstanceID​
String​
是​
mysql-cf8d83******​
实例 ID。​
说明​
您可以按需选择以下接口查询实例 ID:​
InstanceType​
String​
是​
MySQL​
数据库类型,当前支持的数据库如下所示。​
  • MySQL:云数据库 MySQL 版。​
  • VeDBMySQL:云数据库 veDB MySQL 版。​
  • Postgres:云数据库 PostgresSQL 版。​
Ttl​
Integer​
是​
30​
全量 SQL 数据保留总天数。取值为 HotStorageDays、ColdStorageDays 参数取值的和。​
LogProductType​
String​
是​
FullSqlLog​
日志的来源类型,取值如下:​
  • FullSqlLog:表示全量 SQL 日志。​
  • ProxyFullSqlLog:表示代理全量 SQL 日志。​
RegionId​
String​
是​
cn-beijing​
地域 ID。​
CustomStorageSqlMethods​
Array of string​
​
是​
​
[​
"SELECT",​
"INSERT",​
"UPDATE",​
"DELETE",​
"ALTER",​
"CREATE",​
"DROP",​
"RENAME",​
"TRUNCATE",​
"OTHER"​
]​
​
采集并存储的 SQL 类型。​
取值包括:SELECT、INSERT、UPDATE、DELETE、ALTER、CREATE、DROP、RENAME、TRUNCATE、OTHER。​
​
LabelType​
String​
是​
ConsumeTls​
部署标签类型,当前仅支持 ConsumeTls 取值。​
DefaultCloseType​
String​
否​
CloseAuditCollectAndTls​
关闭方式。当前仅支持 CloseAuditCollectAndTls 取值。​
Tags​
Array of TagObject​
否​
​
[​
{​
"Key": "env",​
"Value": "prod"​
}​
]​
​
标签用于标记资源,便于搜索和资源聚合。​
EnableFunctions​
RegionEnableFunctions​
​
否​
​
{​
"SQLAuditDetail": true,​
"SQLInsight": true,​
"EnableHierarchicalStorage": true​
}​
​
当前地域支持的功能开关。​
​
HotStorageDays​
Integer​
否​
7​
标准存储天数。取值范围在 1~1095。​
ColdStorageDays​
Integer​
否​
23​
低频存储时长,取值范围为 30~3648 天,默认值为 30。​
​
返回参数​
​
名称​
类型​
示例值​
描述​
AuditServiceID​
String​
DBW_FullSql_66******-39e1-4139-a785-501a9d******​
全量 SQL 服务实例 ID。​
OrderID​
String​
Order2001000022227******​
计费订单 ID。​
​
请求示例​
​
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​
}​
​
返回示例​
​
{​
"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******"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.09.01 14:02:01
这个页面对您有帮助吗?
有用
有用
无用
无用