1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
RegistryId 必填。大写常量 MARKETPLACE 表示服务端主 YAML marketplace.registry_ids 配置的工具市场;真实 reg-xxx 表示具体 Registry。省略、空字符串、null 或其他大小写均拒绝。市场读取要求已认证身份,只返回配置来源内未删除、已审批的可读版本,文件还须 READY 和有效制品;不回退私有目录。 RecordId 市场可选、普通必填。固定版本查询用 DescribeRegistryRecord;record_id/version_id Filters 已删除。Filters 不扩大权限;市场默认浏览传 label=stable。普通模式保留 AppID 与 CAM,市场版本显式投影公开字段。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRegistryRecordVersionList。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai 。 |
| RegistryId | 是 | String | 父 Registry ID,与 RecordId 同时省略或为空字符串时使用市场查询;两者均非空时使用普通查询。 市场查询仅返回服务端 marketplace.registry_ids 配置来源的未删除资产的 APPROVED 版本;文件还需 READY 且制品可用。普通查询保持 AppID 隔离和原 CAM 权限,即使显式指定官方 Registry 也按普通权限处理。仅一个 ID 非空返回 InvalidParameter。 示例值:MARKETPLACE |
| RecordId | 否 | String | Record ID。市场和普通 Registry 查询均可省略,提供时仅查询该 Record 的版本。 省略时查询 RegistryId 所选范围内的可读版本。查询各 Record 的稳定版本时显式传 Filters 的 label=stable。 示例值:rec-0123abcd |
| Offset | 否 | Integer | 分页起始偏移,默认 0。 示例值:0 |
| Limit | 否 | Integer | 分页条数,默认 20,最大 100。 示例值:20 |
| Filters.N | 否 | Array of CloudFilter | 过滤条件。两种模式默认支持 label、search、descriptor_type、supported_harness_engine、supported_harness_version、metadata. 前缀、status、source_type;record_id 和 version_id 仅支持市场模式。 同 key 多值 OR,不同 key AND。supported_harness_engine 与 supported_harness_version 必须同时提供,分别对 HarnessEngine 和 HarnessEngineVersion 区分大小写精确匹配,并命中 SupportedHarnessVersions 中同一个对象;禁止跨元素组合,未声明兼容性时不匹配,只提供其中一个返回 InvalidParameter.Filters。search 仅允许单个关键词,匹配 Record 名称或描述;label 匹配当前绑定版本。metadata. 后完整小写文本作为顶层 key,按字符串值精确匹配,不解析嵌套路径。status 支持 PREPARING/PENDING_APPROVAL/APPROVED/REJECTED/CANCELED;source_type 支持 MANUAL/URL_IMPORT/TAR_PACKAGE/FILE。未知或重复 key、空 Values、非法值拒绝。无 Filters 不默认 stable,市场默认浏览显式传 label=stable;筛选不能扩大可读范围。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| VersionSet | Array of CloudRecordVersion | 筛选和分页后的版本数组。普通模式指定 RecordId 时按 Revision 降序,普通跨 Record 查询与市场查询均按 CreateTime 降序、VersionId 升序。 市场模式只返回公开字段。支持此版本契约的后端返回 SupportedHarnessVersions 和 Metadata 数组,未设置时返回空数组。Metadata 的每项由字符串 Name 和 Value 组成。无匹配时返回空数组。 |
| TotalCount | Integer | 符合条件的总数。 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 市场模式按 Harness 配对筛选
参数示意;资源 ID、账号、时间、摘要及 example.com URL 为示例,不对应真实资源,请替换后调用。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegistryRecordVersionList
<公共请求参数>
{
"Offset": 0,
"Limit": 20,
"Filters": [
{
"Name": "label",
"Values": [
"stable"
]
},
{
"Name": "descriptor_type",
"Values": [
"PLUGIN"
]
},
{
"Name": "supported_harness_engine",
"Values": [
"pi"
]
},
{
"Name": "supported_harness_version",
"Values": [
"1.3.0"
]
},
{
"Name": "metadata.publisher",
"Values": [
"示例发布者"
]
}
],
"RegistryId": "MARKETPLACE"
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001",
"VersionSet": [
{
"VersionId": "rv-0123abcd",
"RecordId": "rec-0123abcd",
"Revision": 1,
"VersionName": "1.0.0",
"ChangeLog": "首次发布",
"Descriptors": "{\"name\": \"example-plugin\", \"description\": \"示例 Plugin 文件资产\"}",
"Status": "APPROVED",
"LabelSet": [
"latest",
"stable"
],
"SupportedHarnessVersions": [
{
"HarnessEngine": "pi",
"HarnessEngineVersion": "1.3.0"
}
],
"Metadata": [
{
"Name": "publisher",
"Value": "示例发布者"
}
],
"CreateTime": "2030-01-01T00:00:00Z",
"UpdateTime": "2030-01-01T00:00:00Z",
"ContentStatus": "READY",
"ContentSHA256": "2d711642b726b04401627ca9fbac32f5c8530fb1903cc4db02258717921a4881",
"ContentSizeBytes": 1,
"ContentReadyTime": "2030-01-01T00:00:00Z",
"Name": "example-plugin",
"Description": "示例 Plugin 文件资产",
"DescriptorType": "PLUGIN"
}
],
"TotalCount": 1
}
}
示例2 普通模式按 Harness 配对筛选
参数示意;资源 ID、账号、时间、摘要及 example.com URL 为示例,不对应真实资源,请替换后调用。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegistryRecordVersionList
<公共请求参数>
{
"RegistryId": "reg-0123abcd",
"RecordId": "rec-0123abcd",
"Offset": 0,
"Limit": 20,
"Filters": [
{
"Name": "supported_harness_engine",
"Values": [
"pi"
]
},
{
"Name": "supported_harness_version",
"Values": [
"1.3.0"
]
},
{
"Name": "metadata.publisher",
"Values": [
"示例发布者"
]
}
]
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001",
"VersionSet": [
{
"VersionId": "rv-0123abcd",
"RecordId": "rec-0123abcd",
"Revision": 1,
"VersionName": "1.0.0",
"ChangeLog": "首次发布",
"Descriptors": "{\"name\": \"example-plugin\", \"description\": \"示例 Plugin 文件资产\"}",
"SourceType": "FILE",
"SourceConfig": "{\"Type\":\"FILE\",\"SizeBytes\":1}",
"Status": "APPROVED",
"ApprovalMode": "MANUAL",
"ConfigSHA256": "8eb0ce58a4b47f2d9f4154cfe67815d4977b99abdfd35d735219b1d5a5436526",
"LabelSet": [
"latest",
"stable"
],
"SupportedHarnessVersions": [
{
"HarnessEngine": "pi",
"HarnessEngineVersion": "1.3.0"
}
],
"Metadata": [
{
"Name": "publisher",
"Value": "示例发布者"
}
],
"AppId": 1250000000,
"CreatorUin": "100000000001",
"CreatorSubAccountUin": "100000000002",
"CreateTime": "2030-01-01T00:00:00Z",
"UpdateTime": "2030-01-01T00:00:00Z",
"ContentStatus": "READY",
"ContentSHA256": "2d711642b726b04401627ca9fbac32f5c8530fb1903cc4db02258717921a4881",
"ContentSizeBytes": 1,
"ContentReadyTime": "2030-01-01T00:00:00Z",
"Name": "example-plugin",
"Description": "示例 Plugin 文件资产",
"DescriptorType": "PLUGIN"
}
],
"TotalCount": 1
}
}
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.Filters | InvalidParameter.Filters |
| InvalidParameter.Limit | InvalidParameter.Limit |
| InvalidParameter.Offset | InvalidParameter.Offset |
| InvalidParameter.RecordId | InvalidParameter.RecordId |
| InvalidParameter.RegistryId | InvalidParameter.RegistryId |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.RegistryRecord | ResourceNotFound.RegistryRecord |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |