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

数据库工作台

复制全文
下载 pdf
SQL 洞察与审计
PreCheckCreateFullSql
复制全文
下载 pdf
PreCheckCreateFullSql
调用 PreCheckCreateFullSql 接口开启全量 SQL 洞察。​
请求类型​
同步请求。​
请求参数​
​
名称​
类型​
是否必选​
示例值​
描述​
FollowInstanceID​
String​
是​
mysql-cf8d83******​
实例 ID。​
说明​
您可以按需选择以下接口查询实例 ID:​
DSType​
String​
是​
MySQL​
数据库类型,当前支持的数据库如下所示。​
  • MySQL:云数据库 MySQL 版。​
  • VeDBMySQL:云数据库 veDB MySQL 版。​
  • Postgres:云数据库 PostgresSQL 版。​
RegionId​
String​
是​
cn-beijing​
地域 ID。​
​
返回参数​
​
名称​
类型​
示例值​
描述​
PreCheckEnable​
Boolean​
true​
是否已开启全量 SQL。取值如下:​
  • true:表示开启全量 SQL。​
  • false:表示未开启全量 SQL。​
PreCheckFailReason​
String​
Sql insight services are not available in this region​
预检查失败原因。预检查通过时通常为空不展示。​
RegionEnableFunctions​
​
​
{​
"SQLAuditDetail": true,​
"SQLInsight": true,​
"EnableHierarchicalStorage": true​
}​
​
当前地域支持的功能开关。​
​
​
请求示例​
​
POST /?Action=PreCheckCreateFullSql&Version=2018-01-01 HTTP/1.1​
Content-Type: application/json​
Host: dbw.cn-beijing.volcengineapi.com​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
​
{​
"FollowInstanceID": "mysql-cf8d83******",​
"DSType": "MySQL",​
"RegionId": "cn-beijing"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260824103224D22523DC654D4EAAD927-e4f168",​
"Action": "PreCheckCreateFullSql",​
"Version": "2018-01-01",​
"Service": "dbw",​
"Region": "cn-beijing"​
},​
"Result": {​
"PreCheckEnable": true,​
"RegionEnableFunctions": {​
"EnableHierarchicalStorage": true,​
"SQLAuditDetail": true,​
"SQLInsight": true​
}​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.09.01 14:02:01
这个页面对您有帮助吗?
有用
有用
无用
无用