Docs

Database Workshop

SQL insights and auditing

DescribeSQLExecItemMetric

Call the DescribeSQLExecItemMetric API to query the metric curve of a single execution indicator for a specific SQL fingerprint within a specified time range.

Request type

Synchronous request

Request parameters

Name	Type	Is it required?	Sample	Description
InstanceId	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.
StartTime	Integer	Yes	1719820800	Query start time, using second-level timestamps.
EndTime	Integer	Yes	1719824400	The end time of the query, in the format of a second-level timestamp.
ItemType	String	Yes	ExecTime	The type of metric to be queried. The values are as follows: count: The number of SQL executions. ExecTime: The SQL execution duration. RowsAffected: The number of affected rows. RowsSent: The number of returned rows.
RegionId	String	Yes	cn-beijing	Region ID.
SqlFingerprint	String	Yes	a1b2c3d4	SQL fingerprint
NodeId	String	No	node-a	The filter condition for node IDs. If this parameter is specified, the results are aggregated by node.
DbName	String	No	order_db	The filter condition for database names.

Response parameters

Name	Type	Sample	Description
DataPoints	Array of DataPoint	[ { "Abnormal": 0, "TimeStamp": 1787541550, "Value": 0 }, { "Abnormal": 0, "TimeStamp": 1787627086, "Value": 2 } ]	List of metric curve data points.

Request example

POST /?Action=DescribeSQLExecItemMetric&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****​
​
{​
    "InstanceId": "mysql-cf8d83******",​
    "InstanceType": "MySQL",​
    "StartTime": 1787541550,​
    "EndTime": 1787627950,​
    "SqlFingerprint": "9382a62734fc854f6c2df7431685bd75",​
    "ItemType": "count",​
    "DbName": "-",​
    "RegionId": "cn-beijing"​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "20260825111917371FF12D152EE64C2CB7-42b6db",​
        "Action": "DescribeSQLExecItemMetric",​
        "Version": "2018-01-01",​
        "Service": "dbw",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "DataPoints": [​
            {​
                "Abnormal": 0,​
                "TimeStamp": 1787541550,​
                "Value": 0​
            },​
            {​
                "Abnormal": 0,​
                "TimeStamp": 1787627086,​
                "Value": 2​
            }​
        ]​
    }​
}​

Error code

For details, refer to Error codes.

Last updated: 2026.09.01 16:59:34