1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
RegistryId 必填。大写常量 MARKETPLACE 表示服务端主 YAML marketplace.registry_ids 配置的工具市场;真实 reg-xxx 表示具体 Registry。省略、空字符串、null 或其他大小写均拒绝。市场读取要求已认证身份,只返回配置来源内未删除、已审批的可读版本,文件还须 READY 和有效制品;不回退私有目录。 RecordId 必填,VersionId/Label 互斥,均省略解析 stable;市场无可读 stable 返回 ResourceNotFound,不回退 latest。市场 Record/Version 使用公开字段投影,隐藏创建者、租户、审批动作和 SourceConfig。普通模式保留原 AppID/归属,由后端执行 Record 级 CAM batch 检查。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRegistryRecord。 |
| 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 |
| RecordId | 是 | String | Record ID。 示例值:rec-0123abcd |
| VersionId | 否 | String | Version ID,与 Label 互斥。指定时返回该 Version;均省略时等价于 Label=stable。 示例值:rv-0123abcd |
| Label | 否 | String | Label 名称,与 VersionId 互斥。指定时返回 Label 当前指向的 Version;均省略时等价于 stable。 示例值:stable |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Record | CloudRecord | Record 元数据和全部 Label。 |
| Version | CloudRecordVersion | 根据 VersionId / Label 解析得到的完整 Version。 注意:此字段可能返回 null,表示取不到有效值。 |
| ResolvedBy | String | 解析方式:DEFAULT_STABLE / LABEL / VERSION_ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:DEFAULT_STABLE |
| ResolvedLabel | String | 通过 Label 解析(ResolvedBy=LABEL 或 DEFAULT_STABLE)时返回该 Label 名称,例如 stable。 注意:此字段可能返回 null,表示取不到有效值。 示例值:stable |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按 Label=stable 查询
VersionId 与 Label 互斥;均省略时等价于 Label=stable。
输入示例
POST / HTTP/1.1
Host: ags.internal.tencentcloudapi.com
X-TC-Action: DescribeRegistryRecord
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",
"Record": {
"RecordId": "rec-0123abcd",
"Name": "order-query",
"LabelSet": [
"stable",
"latest"
]
},
"Version": {
"VersionId": "rv-0123abcd",
"Revision": 2,
"Status": "APPROVED",
"Metadata": [],
"SupportedHarnessVersions": []
},
"ResolvedBy": "LABEL",
"ResolvedLabel": "stable"
}
}
示例2 按 VersionId 精确查询
指定 VersionId 时不返回 ResolvedLabel。
输入示例
POST / HTTP/1.1
Host: ags.internal.tencentcloudapi.com
X-TC-Action: DescribeRegistryRecord
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",
"VersionId": "rv-0123abcd"
}
输出示例
{
"Response": {
"RequestId": "req-example",
"Record": {
"RecordId": "rec-0123abcd",
"Name": "order-query"
},
"Version": {
"VersionId": "rv-0123abcd",
"Revision": 2,
"Status": "APPROVED",
"Metadata": [],
"SupportedHarnessVersions": []
},
"ResolvedBy": "VERSION_ID"
}
}
示例3 使用 MARKETPLACE 查询市场固定版本详情
示例资源 ID 请替换;MARKETPLACE 为固定大写常量,市场响应只包含公开字段。
输入示例
POST / HTTP/1.1
Host: ags.internal.tencentcloudapi.com
X-TC-Action: DescribeRegistryRecord
X-TC-Version: 2025-09-20
X-TC-Region: ap-guangzhou
X-TC-RequestId: req-example
Content-Type: application/json
{
"RegistryId": "MARKETPLACE",
"RecordId": "rec-0123abcd",
"VersionId": "rv-0123abcd"
}
输出示例
{
"Response": {
"RequestId": "req-example",
"Record": {
"RecordId": "rec-0123abcd",
"Name": "order-query",
"LabelSet": [
"stable",
"latest"
]
},
"Version": {
"VersionId": "rv-0123abcd",
"Revision": 2,
"Status": "APPROVED",
"Metadata": [],
"SupportedHarnessVersions": []
},
"ResolvedBy": "VERSION_ID",
"ResolvedLabel": "stable"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter.RecordId | InvalidParameter.RecordId |
| InvalidParameter.RecordSelector | InvalidParameter.RecordSelector |
| InvalidParameter.RegistryId | InvalidParameter.RegistryId |
| InvalidParameter.VersionId | InvalidParameter.VersionId |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.RegistryRecord | ResourceNotFound.RegistryRecord |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |