1. 接口描述
接口请求域名: monitor.tencentcloudapi.com 。
查询制品详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeAIWorkbenchArtifact。 |
| Version | 是 | String | 公共参数,本接口取值:2023-06-16。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| ArtifactId | 是 | String | 产物 ID 示例值:a9***c86 |
| NeedDownloadURL | 否 | Integer | 是否需要下载 URL
示例值:1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Artifact | ArtifactInfo | 产物信息 注意:此字段可能返回 null,表示取不到有效值。 |
| DownloadURL | String | COS 预签名下载 URL 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://observability-* |
| DownloadURLExpiredAt | String | 下载 URL 过期时间(RFC3339 格式) 示例值:2026-05-26T08:50:29Z |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询制品详情
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIWorkbenchArtifact
<公共请求参数>
{
"ArtifactId": "a9***************************c86",
"NeedDownloadURL": 1
}
输出示例
{
"Response": {
"Artifact": {
"AgentId": "agt-fl41a45q",
"ArtifactId": "a9b50a2ab7fd09af3ae37c6f0262cc86",
"CreatedAt": 0,
"IsGlobal": false,
"MimeType": "application/json",
"Name": "instances.json",
"SizeBytes": 41,
"SkillId": "skl-183na51w",
"StoragePath": "sandbox_file://ses-n3qlvaiqqfwn/instances.json",
"UpdatedAt": 0
},
"DownloadURL": "https://observability-*****************************************************************************************************************************************************************************************************************************************************************************************************************************",
"DownloadURLExpiredAt": "2026-05-26T08:50:29Z",
"RequestId": "8fe8e08b-a92d-4b0a-82bd-08404a3365c4"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnauthorizedOperation | 未授权操作。 |