帮你快速理解、总结文档立即下载
文档中心>API 中心>Agent Runtime>注册记录管理相关接口>测试调用 Record 端点

测试调用 Record 端点

最近更新时间：2026-09-24 01:08:47
我的收藏

本页目录：

1. 接口描述

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

对 Record 的指定 Version 或 Label 目标发起一次预览调用。VersionId 与 Label 互斥；均省略时使用 Stable。不创建 Version、不修改 Label。

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

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

2. 输入参数

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

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

父 Registry ID。


示例值：reg-0123abcd
RecordId 是 String

Record ID。


示例值：rec-0123abcd
VersionId 否 String

可选。指定要预览的目标 Version；与 Label 互斥；均省略时使用 Stable。


示例值：rv-0123abcd
Label 否 String

可选。指定要预览的目标 Label；与 VersionId 互斥；均省略时使用 Stable。


示例值：stable

3. 输出参数

参数名称 类型 描述
PreviewResult String

只读元数据预览结果对象（JSON 字符串形式）。字段：StatusCode（远端 HTTP 状态码，必返）、Body（远端响应体截断字符串，必返）、HasUpdate（Boolean，必返；远端内容按 Sync 相同的规范化规则处理后是否与请求 Version 配置不同；Error 非空时固定返回 false，此时不表示远端没有变化）、Error（调用错误信息，可选）。


示例值：{"StatusCode": 200, "Body": "{}", "HasUpdate": true}
ResolvedVersionId String

实际预览的 Version ID（由 VersionId / Label 解析得到）。


示例值：rv-0123abcd
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 预览 Stable 目标

不创建 Version、不修改 Label；仅返回一次拉取结果。

输入示例

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

{
    "RegistryId": "reg-0123abcd",
    "RecordId": "rec-0123abcd",
    "Label": "stable"
}

输出示例

{
    "Response": {
        "RequestId": "req-example",
        "PreviewResult": "{\"StatusCode\": 200, \"Body\": \"{\\\"name\\\":\\\"example.com/weather\\\"}\", \"HasUpdate\": false}",
        "ResolvedVersionId": "rv-0123abcd"
    }
}

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.RecordId InvalidParameter.RecordId
InvalidParameter.RecordSelector InvalidParameter.RecordSelector
InvalidParameter.RegistryId InvalidParameter.RegistryId
InvalidParameter.VersionId InvalidParameter.VersionId
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
ResourceNotFound.RegistryRecord ResourceNotFound.RegistryRecord
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站