文档中心

数据库工作台

SQL 洞察与审计

DescribeFullSqlStatus

调用 DescribeFullSqlStatus 接口查询指定实例的全量 SQL 开通状态、功能状态和订阅配置。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
FollowInstanceID	String	是	mysql-fcfc2c******	实例 ID。说明您可以按需选择以下接口查询实例 ID：调用 DescribeDBInstances 接口查询 MySQL 的实例 ID。调用 DescribeDBInstances 接口查询 veDB MySQL 的实例 ID。调用 DescribeDBInstances 接口查询 PostgreSQL 的实例 ID。
DSType	String	是	MySQL	数据库类型，当前支持的数据库如下所示。 MySQL：云数据库 MySQL 版。 VeDBMySQL：云数据库 veDB MySQL 版。 Postgres：云数据库 PostgresSQL 版。
RegionId	String	是	cn-beijing	地域 ID。

返回参数

名称	类型	示例值	描述
DetailStatus	String	RUN	SQL 审计明细功能状态。取值如下： RUN：表示 SQL 审计明细已开启。 STARTING：表示 SQL 审计明细开启中。 CLOSE：表示 SQL 审计明细已关闭。 DELETE：表示 SQL 审计明细被删除中。 MODIFYING：表示 SQL 审计明细变更中。
BusinessStatus	String	InstanceBusinessRunning	计费状态。取值如下： InstanceBusinessPending：表示等待支付中。 InstanceBusinessRunning：表示计费实例执行中。
SqlAnalysisFunStatus	String	RUN	SQL 洞察功能状态。取值如下 RUN：表示 SQL 洞察功能已开启。 STARTING：表示 SQL 洞察功能开启中。 CLOSE：表示 SQL 洞察功能已关闭。 DELETE：表示 SQL 洞察功能被删除中。 MODIFYING：表示 SQL 洞察功能变更中。
InstanceID	String	DBW_FullSql_ed82b2b4-b985-4861-b19d-e0d2bd******	全量 SQL 服务实例 ID。
EnableFunctions	RegionEnableFunctions	{ "EnableHierarchicalStorage": true, "SQLAuditDetail": true, "SQLInsight": true }	当前全量 SQL 实例已开启的功能集合。
SqlRetentionDay	Integer	30	SQL 数据存储时长。
CustomStorageSqlMethods	Array of string	[ "SELECT", "INSERT" ]	采集并存储的 SQL 类型。取值包括：SELECT、INSERT、UPDATE、DELETE、ALTER、CREATE、DROP、RENAME、TRUNCATE、OTHER。
HotStorageDays	Integer	7	标准存储天数。取值范围在 1~1095。
ColdStorageDays	Integer	23	低频存储时长，取值范围为 30~3648 天，默认值为 30。

请求示例

POST /?Action=DescribeFullSqlStatus&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-fcfc2c******",​
    "DSType": "MySQL",​
    "RegionId": "cn-beijing"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20260824153433A83D2926F422A237031E-cee933",​
        "Action": "DescribeFullSqlStatus",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "ArchiveStorageDays": 0,​
        "BusinessStatus": "InstanceBusinessPending",​
        "ColdStorageDays": 30,​
        "CustomStorageSqlMethods": [​
            "SELECT",​
            "INSERT",​
            "UPDATE",​
            "DELETE",​
            "ALTER",​
            "CREATE",​
            "DROP",​
            "RENAME",​
            "TRUNCATE",​
            "OTHER"​
        ],​
        "DetailStatus": "RUN",​
        "EnableFunctions": {​
            "EnableHierarchicalStorage": true,​
            "SQLAuditDetail": true,​
            "SQLInsight": true​
        },​
        "HotStorageDays": 1,​
        "InstanceID": "DBW_FullSql_43******-ac6e-4199-bf2b-c38dbec672c7",​
        "InstanceStatus": "InstanceStatusPending",​
        "SqlAnalysisFunStatus": "RUN",​
        "SqlRetentionDay": 31​
    }​
}​

错误码

更多详情，请参见错误码。

最近更新时间：2026.09.01 14:02:01

这个页面对您有帮助吗？

有用

无用