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

同步 Record 描述符

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

1. 接口描述

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

触发一次从远端拉取描述符 / 元数据的同步。可通过互斥的 VersionId 或 Label 指定来源 Version,均省略时默认使用 Stable。有变化时创建新 Version 并移动 Latest;来源必须 SourceType=URL_IMPORT,否则返回 UnsupportedOperation.SourceType。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:SyncRegistryRecord。
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。Label 在请求开始时只解析一次。


示例值:stable
ChangeLog 否 String

可选,最大 4096 字符。若同步创建新 Version,将写入新 Version 的 ChangeLog;省略时保存为空。


示例值:更新版本

3. 输出参数

参数名称 类型 描述
SyncStatus String

同步结果:UNCHANGED(远端无变化)/ VERSION_CREATED(远端有变化,已生成新 Version)/ FAILED(同步失败)。


注意:此字段可能返回 null,表示取不到有效值。
示例值:VERSION_CREATED
ResolvedVersionId String

作为同步来源解析出的 Version ID(可能由 Label 解析而来);不为空。


注意:此字段可能返回 null,表示取不到有效值。
示例值:rv-0123abcd
CreatedVersion CloudRecordVersion

SyncStatus=VERSION_CREATED 时返回:本次新建的 Version。

Record CloudRecord

SyncStatus=VERSION_CREATED 时返回:同步后的最新 Record。

LastSyncTime String

最后一次同步时间,ISO 8601 UTC。


注意:此字段可能返回 null,表示取不到有效值。
示例值:2026-08-12T00:00:00Z
ErrorCode String

失败错误码;SyncStatus=FAILED 时返回。


注意:此字段可能返回 null,表示取不到有效值。
示例值:sync_failed
ErrorMessage String

失败错误信息;SyncStatus=FAILED 时返回。


注意:此字段可能返回 null,表示取不到有效值。
示例值:远端返回 500 Internal Server Error
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 同步 Stable 目标 Version

从远端拉取到新内容时创建新 Version 并移动 Latest;Stable 保持不变。

输入示例

POST / HTTP/1.1
Host: ags.internal.tencentcloudapi.com
X-TC-Action: SyncRegistryRecord
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",
    "ChangeLog": "远端 MCP 更新,同步为 v3"
}

输出示例

{
    "Response": {
        "RequestId": "req-example",
        "SyncStatus": "VERSION_CREATED",
        "ResolvedVersionId": "rv-0123abcd",
        "CreatedVersion": {
            "VersionId": "rv-0005abcd",
            "Revision": 5
        },
        "Record": {
            "RecordId": "rec-0123abcd"
        },
        "LastSyncTime": "2026-08-12T00:00:00Z"
    }
}

示例2 远端未变化

远端无变化时不创建 Version、不修改 Label。

输入示例

POST / HTTP/1.1
Host: ags.internal.tencentcloudapi.com
X-TC-Action: SyncRegistryRecord
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",
        "SyncStatus": "UNCHANGED",
        "ResolvedVersionId": "rv-0123abcd",
        "LastSyncTime": "2026-08-12T00:00:00Z"
    }
}

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 操作不支持。