1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询镜像仓库资产总览
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeImageRegistryAssetOverview。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-12e1se11"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ImageCnt | Integer | 镜像总数 示例值:319 |
| ImageScannedCnt | Integer | 已扫描镜像数 示例值:189 |
| ComponentCnt | Integer | 组件数 示例值:4805 |
| VulCnt | Integer | 漏洞数 示例值:419 |
| VirusCnt | Integer | 木马数 示例值:496 |
| SensitiveCnt | Integer | 敏感信息数 示例值:118 |
| TimedScanTaskConfigCnt | Integer | 定时扫描配置数 示例值:5 |
| TotalQuota | Integer | 总配额 示例值:1010 |
| UsedQuota | Integer | 已使用配额 示例值:0 |
| RemainingQuota | Integer | 剩余配额 示例值:1010 |
| TrialQuota | Integer | 试用配额 示例值:0 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询镜像仓库资产总览
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImageRegistryAssetOverview
<公共请求参数>
{
"MemberId": [
"mem-12e1se11"
]
}
输出示例
{
"Response": {
"ComponentCnt": 4805,
"ImageCnt": 319,
"ImageScannedCnt": 189,
"RemainingQuota": 1010,
"SensitiveCnt": 118,
"TimedScanTaskConfigCnt": 5,
"TotalQuota": 1010,
"TrialQuota": 0,
"UsedQuota": 0,
"VirusCnt": 496,
"VulCnt": 419,
"RequestId": "aa4beda5-11ef-4295-a4c9-2713255b7e96"
}
}
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 | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ResourceId | InvalidParameter.ResourceId |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation.NoPermission | UnauthorizedOperation.NoPermission |
| UnknownParameter | 未知参数错误。 |