1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
镜像仓库镜像仓库列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAssetImageRegistryList。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Limit | 否 | Integer | 需要返回的数量,默认为10,最大值为100 |
Offset | 否 | Integer | 偏移量,默认为0 |
Filters.N | 否 | Array of AssetFilters | 过滤字段 IsAuthorized是否授权,取值全部all,未授权0,已授权1 |
By | 否 | String | 排序字段 |
Order | 否 | String | 排序方式,asc,desc |
OnlyShowLatest | 否 | Boolean | 是否仅展示各repository最新的镜像, 默认为false 示例值:false |
IsRunning | 否 | Boolean | 是否仅展示运行中容器镜像 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
List | Array of ImageRepoInfo | 镜像仓库列表 注意:此字段可能返回 null,表示取不到有效值。 |
TotalCount | Integer | 总数量 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 镜像仓库查询镜像仓库列表
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetImageRegistryList
<公共请求参数>
{
"Filters": [
{
"ExactMatch": false,
"Name": "ScanStatus",
"Values": [
"all"
]
},
{
"ExactMatch": false,
"Name": "RepoType",
"Values": [
"all"
]
},
{
"ExactMatch": false,
"Name": "SecurityRisk",
"Values": [
"all"
]
},
{
"ExactMatch": false,
"Name": "IsAuthorized",
"Values": [
"all"
]
}
],
"Limit": 10,
"Offset": 0
}
输出示例
{
"Response": {
"RequestId": "a17ead82-00d3-4bf2-8ec2-55292c42d6e3",
"TotalCount": 100,
"List": [
{
"Id": 20933905,
"ImageDigest": "sha256:8d8d7593f6da4e909bba63a3a22080eca935c57afd81ad0b8f069b90064324ba",
"ImageId": "sha256:a810b384f08c95a472d7364b9b3198d4746f1ea001a26c5cb9d7e95272004afc",
"RegistryType": "ccr",
"RegistryRegion": "default",
"ImageRepoAddress": "ccr.ccs.tencentyun.com/xcar/executor",
"InstanceId": "",
"InstanceName": "ccr-default",
"Namespace": "xcar",
"ImageName": "executor",
"ImageTag": "latest",
"ImageSize": 22952972,
"ScanTime": "",
"ScanStatus": "NOT_SCAN",
"Progress": 0,
"VulCnt": 0,
"VirusCnt": 0,
"RiskCnt": 0,
"SentiveInfoCnt": 0,
"IsTrustImage": false,
"OsName": "linux",
"ScanVirusError": "",
"ScanVulError": "",
"ScanRiskError": "",
"ScanVirusProgress": 0,
"ScanVulProgress": 0,
"ScanRiskProgress": 0,
"ScanRemainTime": 0,
"CveStatus": "NOT_SCAN",
"RiskStatus": "NOT_SCAN",
"VirusStatus": "NOT_SCAN",
"IsAuthorized": 0,
"ImageCreateTime": "2020-09-22T00:00:00+00:00",
"IsLatestImage": true
},
{
"Id": 20933905,
"ImageDigest": "sha256:8d8d7593f6da4e909bba63a3a22080eca935c57afd81ad0b8f069b90064324ba",
"ImageId": "sha256:a810b384f08c95a472d7364b9b3198d4746f1ea001a26c5cb9d7e95272004afc",
"RegistryType": "ccr",
"RegistryRegion": "default",
"ImageRepoAddress": "ccr.ccs.tencentyun.com/xcar/executor",
"InstanceId": "",
"InstanceName": "ccr-default",
"Namespace": "xcar",
"ImageName": "executor",
"ImageTag": "latest",
"ImageSize": 22952972,
"ScanTime": "",
"ScanStatus": "NOT_SCAN",
"Progress": 0,
"VulCnt": 0,
"VirusCnt": 0,
"RiskCnt": 0,
"SentiveInfoCnt": 0,
"IsTrustImage": false,
"OsName": "linux",
"ScanVirusError": "",
"ScanVulError": "",
"ScanRiskError": "",
"ScanVirusProgress": 0,
"ScanVulProgress": 0,
"ScanRiskProgress": 0,
"ScanRemainTime": 0,
"CveStatus": "NOT_SCAN",
"RiskStatus": "NOT_SCAN",
"VirusStatus": "NOT_SCAN",
"IsAuthorized": 0,
"ImageCreateTime": "2020-09-22T00:00:00+00:00",
"IsLatestImage": true
}
]
}
}
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 | 操作失败。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |