文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 全量SQL/ 导出全量单条SQL列表 - ExportingFullDatabySQLStatement
更新时间:2025-12-25 GMT+08:00
分享

导出全量单条SQL列表 - ExportingFullDatabySQLStatement

功能介绍

导出全量单条SQL列表。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/{project_id}/instances/{instance_id}/list-full-sqls/export

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围

  • zh-cn
  • en-us

默认取值

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

node_id

String

参数解释:

节点ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

begin_time

String

参数解释:

查询开始时间。

约束限制:

ISO 8601 UTC格式。模式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量。

时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。

例如:北京时间偏移显示为+0800,begin_time=2024-03-15T17:20:33+0800,传参时编码为begin_time=2024-03-15T17:20:33%2B0800。

取值范围:

时间区间(begin_time ~ end_time)不能超过30天。

默认取值

不涉及。

end_time

String

参数解释:

查询结束时间。

约束限制:

ISO 8601 UTC格式。模式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量。

时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。

例如:北京时间偏移显示为+0800,end_time=2024-03-16T17:20:33+0800,传参时编码为end_time=2024-03-16T17:20:33%2B0800。

取值范围:

时间区间(begin_time ~ end_time)不能超过30天。

默认取值

不涉及。

query

String

参数解释:

SQL文本。

约束限制:

不涉及。

取值范围:

长度1-4096。

默认取值

不涉及。

sql_id

String

参数解释:

归一化SQL ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

sql_exec_id

String

参数解释:

唯一SQL ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

transaction_id

String

参数解释:

事务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

trace_id

String

参数解释:

链路ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

db_name

String

参数解释:

数据库名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

schema_name

String

参数解释:

schema名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

username

String

参数解释:

用户名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

client_addr

String

参数解释:

客户端地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

client_port

String

参数解释:

客户端端口。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

order_by

String

参数解释:

排序字段。

约束限制:

不涉及。

取值范围:

begin_time:起始时间。

默认取值

begin_time

is_slow_sql

Boolean

参数解释:

是否为慢SQL。

约束限制:

不涉及。

取值范围:

  • true:是慢SQL。
  • false:不是慢SQL。

默认取值

不涉及。

order

String

参数解释:

排序方式,支持升序和降序。

约束限制:

不涉及。

取值范围:

  • DESC:降序。
  • desc:降序。
  • ASC:升序。
  • asc:升序。

默认取值

DESC

multi_queries

Array of objects

参数解释

字段汇聚查询条件列表。默认取值为[]。

详情请参见表4 MultiMergeCondition

约束限制:

只支持针对query字段全与或者全或的查询。

compare_conditions

Array of objects

参数解释:

组合比较查询条件,可针对某个给定过滤字段,进行区间范围、大小、小于等条件合并查询。默认取值为[]。详情请参见表5 CompareCondition

约束限制:

不涉及。

limit

Long

参数解释:

最大查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。

约束限制:

对于公有云25.5.0.1及以上版本,此参数弃用,请勿传值。通过系统系统参数控制最大返回记录数量,默认为200。

取值范围:

[1, 1000]

默认取值

默认为10。

表4 MultiMergeCondition

参数

是否必选

参数类型

描述

name

String

参数解释

查询字段名称。

约束限制:

只支持字符串"query"。

取值范围:

由英文字母(大小写)、数字或下划线组成,长度为 1 至 128 个字符。

默认取值

不涉及。

condition

String

参数解释

合并条件。

约束限制:

不涉及。

取值范围:

仅限字符串:"and"、"or"、"AND"、"OR"。

默认取值

不涉及。

values

Array of strings

参数解释

多个过滤检索条件内容集合。由 1 至 5 个字符串组成的列表。

约束限制:

不涉及。

is_fuzzy

Boolean

参数解释

多个过滤检索条件内容集合。

约束限制:

只支持为true进行模糊查询。

取值范围:

  • true 表示模糊查询。
  • false 表示精确匹配。

默认取值

true

表5 CompareCondition

参数

是否必选

参数类型

描述

name

String

参数解释

查询字段名称,当前仅支持特定的数值字段。

约束限制:

不涉及。

取值范围

  • db_time:有效DB时间。
  • cpu_time:CPU耗时。
  • data_io_time:IO耗时。
  • execution_time:执行器内耗时。

默认取值

不涉及。

enable_equal

Boolean

参数解释

是否使能包含等于,如果为true,则表示包含边界条件(min或max)的取值。

约束限制:

不涉及。

取值范围:

  • true:包含区间边界。
  • false:不包含区间边界。

默认取值

true

min

Long

参数解释

最小值判断条件对应取值(大于条件)。

约束限制:

不涉及。

取值范围:

[0, 2^63-1]

默认取值

不涉及。

max

Long

参数解释

最大值判断条件对应取值(小于条件)。

约束限制:

不涉及。

取值范围:

[0, 2^63-1]

默认取值

不涉及。

value

Long

参数解释

等值判断条件对应取值(等于条件)。value的优先级最高,如果value不为空,则忽略min和max的取值设置;value为空时,才使能min和max的条件过滤。

约束限制:

不涉及。

取值范围:

[0, 2^63-1]

默认取值

不涉及。

响应参数

无。

请求示例

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/4a89780fa1024361bcb855fed6aab89e/instances/cf9c879513144362bce2b3760ed81d3bin14/list-full-sqls/export
{
    "begin_time": "2025-08-08T08:59:29+0000",
    "end_time": "2025-08-08T09:59:29+0000",
    "compare_conditions": [{
            "name": "db_time",
            "min": 474,
            "max": 475,
            "enable_equal": true
        }
    ],
    "multi_queries": [{
            "name": "query",
            "condition": "AND",
            "is_fuzzy": true,
            "values": ["select node_name", "from pg_catalog.pgxc_node"]
        }
    ]
}

响应示例

无。

状态码

错误码

请参见错误码

相关文档