大数据智能体工作台 DataBuddy 分页查询存储位置列表

1. 接口描述

接口请求域名： databuddy.tencentcloudapi.com 。

分页查询存储位置列表
使用场景：分页查询数据湖仓库中的存储位置详情列表，支持模式匹配和快照分页

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListLocations。
Version	是	String	公共参数，本接口取值：2026-07-15。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。
WorkspaceId	是	String	调用时所在workspace唯一id，必填示例值：17678671667189298
LocationNamePattern	否	String	存储位置名匹配模式，支持SQL LIKE语法示例值：%
SnapshotBased	否	Boolean	是否基于快照分页示例值：false
SnapshotId	否	String	快照ID 示例值：snapshot123
PageNumber	否	Integer	页码，从1开始，可选，默认1 示例值：1
PageSize	否	Integer	每页大小，默认10，取值范围 1~500 示例值：10

3. 输出参数

参数名称	类型	描述
Data	ListLocationsRsp	返回结果
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询存储位置列表

分页查询存储位置列表

输入示例

POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListLocations
<公共请求参数>

{
    "WorkspaceId": "17678671667189298",
    "PageNumber": 1,
    "PageSize": 10
}

输出示例

{
    "Response": {
        "Data": {
            "Locations": [
                {
                    "Audit": {
                        "CreatedAt": "1776757339732",
                        "Creator": "********4619",
                        "CreatorName": "*******0**e******n*e**.***",
                        "LastModifiedAt": "1777380384696",
                        "LastModifier": "********4619",
                        "LastModifierName": "********-t****@*e*****.com"
                    },
                    "Comment": "编辑描述123123123",
                    "LocationName": "bucunzaibucunzai",
                    "LocationUri": "***://*ta*n*ti**c**y*******************p***a**z**u********9*",
                    "Properties": []
                }
            ],
            "SnapshotId": "",
            "TotalCount": 11
        },
        "RequestId": "e9bf167d-c38f-4de4-a6eb-0c7e19bdc0ff"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。