帮你快速理解、总结文档立即下载

查询 Record 列表

最近更新时间:2026-11-20 19:48:52
我的收藏

1. 接口描述

接口请求域名: ags.tencentcloudapi.com 。

RegistryId 必填。大写常量 MARKETPLACE 表示服务端主 YAML marketplace.registry_ids 配置的工具市场;真实 reg-xxx 表示具体 Registry。省略、空字符串、null 或其他大小写均拒绝。市场读取要求已认证身份,只返回配置来源内未删除、已审批的可读版本,文件还须 READY 和有效制品;不回退私有目录。 返回至少有一个市场可读版本的 Record;去重、过滤、计数后分页,VersionCount/LabelSet 只反映市场可读版本,隐藏租户及创建者信息。真实 RegistryId 保留原 AppID/CAM 资源过滤,接口由后端自行鉴权。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeRegistryRecordList。
Version 是 String 公共参数,本接口取值:2025-09-20。
Region 是 String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。
RegistryId 是 String

RegistryId 必填。大写常量 MARKETPLACE 表示服务端主 YAML marketplace.registry_ids 配置的工具市场;真实 reg-xxx 表示具体 Registry。省略、空字符串、null 或其他大小写均拒绝。市场读取要求已认证身份,只返回配置来源内未删除、已审批的可读版本,文件还须 READY 和有效制品;不回退私有目录。


示例值:MARKETPLACE
Offset 否 Integer

分页起始偏移,默认 0。


示例值:0
Limit 否 Integer

分页条数,默认 20,最大 100。


示例值:20
Filters.N 否 Array of CloudFilter

过滤条件。支持 Filter.Name:name/search(按 Record Name 模糊搜索);其他名称返回 InvalidParameter.Filters.Name。

3. 输出参数

参数名称 类型 描述
RecordSet Array of CloudRecord

Record 对象数组。

TotalCount Integer

符合条件的总数。


示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 weather 相关 Record

输入示例

POST / HTTP/1.1
Host: ags.internal.tencentcloudapi.com
X-TC-Action: DescribeRegistryRecordList
X-TC-Version: 2025-09-20
X-TC-Region: ap-guangzhou
X-TC-RequestId: req-example
Content-Type: application/json

{
    "RegistryId": "reg-0123abcd",
    "Offset": 0,
    "Limit": 20,
    "Filters": [
        {
            "Name": "search",
            "Values": [
                "weather"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "req-example",
        "RecordSet": [],
        "TotalCount": 0
    }
}

示例2 使用 MARKETPLACE 查询市场资产列表

示例资源 ID 请替换;MARKETPLACE 为固定大写常量,市场响应只包含公开字段。

输入示例

POST / HTTP/1.1
Host: ags.internal.tencentcloudapi.com
X-TC-Action: DescribeRegistryRecordList
X-TC-Version: 2025-09-20
X-TC-Region: ap-guangzhou
X-TC-RequestId: req-example
Content-Type: application/json

{
    "RegistryId": "MARKETPLACE",
    "Offset": 0,
    "Limit": 20,
    "Filters": [
        {
            "Name": "search",
            "Values": [
                "weather"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "req-example",
        "RecordSet": [],
        "TotalCount": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter.Filters InvalidParameter.Filters
InvalidParameter.Limit InvalidParameter.Limit
InvalidParameter.Offset InvalidParameter.Offset
InvalidParameter.RegistryId InvalidParameter.RegistryId
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。