1. 接口描述
接口请求域名: tiia.tencentcloudapi.com 。
查询所有的图库信息。
- 可前往 图像搜索 产品文档中查看更多产品信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeGroups。 |
Version | 是 | String | 公共参数,本接口取值:2019-05-29。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 否 | Integer | 起始序号,默认值为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认值为10,最大值为100。 示例值:1 |
GroupId | 否 | String | 图库ID,如果不为空,则返回指定库信息。 示例值:test_group |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Groups | Array of GroupInfo | 图库信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用成功示例
查询当前用户的图片库信息。
输入示例
POST / HTTP/1.1
Host: tiia.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGroups
<公共请求参数>
{
"Offset": 0,
"Limit": 100
}
输出示例
{
"Response": {
"Groups": [
{
"Brief": "",
"CreateTime": "2023-02-02 18:04:08",
"GroupId": "group_test_id",
"GroupName": "group_test_id_name",
"GroupType": 4,
"MaxCapacity": 10000,
"MaxQps": 10,
"PicCount": 1,
"UpdateTime": "2023-02-02 18:04:41"
}
],
"RequestId": "347a9402-b68c-42d0-8a75-d1b123fe83d5"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.RequestError | 后端服务请求失败。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.RpcFail | RPC请求失败,一般为算法微服务故障。 |
InvalidParameter.InvalidParameter | 参数取值错误。 |
InvalidParameterValue.ImageGroupIdIllegal | 图库ID不合法。 |
InvalidParameterValue.ImageGroupIdNotExist | 图库ID不存在。 |
InvalidParameterValue.ImageGroupIdTooLong | 图库ID超出长度限制。 |
ResourceUnavailable.InArrears | 账号已欠费。 |
ResourceUnavailable.NotExist | 计费状态未知,请确认是否已在控制台开通服务。 |