1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
批量授权镜像扫描V2.0
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyImageAuthorized。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
AllLocalImages | 是 | Boolean | 本地镜像是否全部授权的标识,优先权高于根据本地镜像ids授权。等于true时需UpdatedLocalImageCnt大于0。 |
AllRegistryImages | 是 | Boolean | 仓库镜像是否全部授权的标识,优先权高于根据镜像ids授权。等于true时需UpdatedRegistryImageCnt大于0。 |
UpdatedLocalImageCnt | 是 | Integer | 指定操作授权的本地镜像数量,判断优先权最高,实际多出的镜像随机忽略,实际不足的部分也忽略。 |
UpdatedRegistryImageCnt | 是 | Integer | 指定操作授权的仓库镜像数量,判断优先权最高,实际多出的镜像随机忽略,实际不足的部分也忽略; |
ImageSourceType | 是 | String | 根据满足条件的本地镜像授权,本地镜像来源;ASSETIMAGE:本地镜像列表;IMAGEALL:同步本地镜像;AllLocalImages为false且LocalImageIds为空和UpdatedLocalImageCnt大于0时,需要 |
LocalImageFilter.N | 否 | Array of AssetFilters | 根据满足条件的本地镜像授权,AllLocalImages为false且LocalImageIds为空和UpdatedLocalImageCnt大于0时,需要。 |
RegistryImageFilter.N | 否 | Array of AssetFilters | 根据满足条件的仓库镜像授权,AllRegistryImages为false且RegistryImageIds为空和UpdatedRegistryImageCnt大于0时,需要。 |
ExcludeLocalImageIds.N | 否 | Array of String | 根据满足条件的镜像授权,同时排除的本地镜像。 |
ExcludeRegistryImageIds.N | 否 | Array of String | 根据满足条件的镜像授权,同时排除的仓库镜像。 |
LocalImageIds.N | 否 | Array of String | 根据本地镜像ids授权,优先权高于根据满足条件的镜像授权。AllLocalImages为false且LocalImageFilter为空和UpdatedLocalImageCnt大于0时,需要。 |
RegistryImageIds.N | 否 | Array of String | 根据仓库镜像Ids授权,优先权高于根据满足条件的镜像授。AllRegistryImages为false且RegistryImageFilter为空和UpdatedRegistryImageCnt大于0时,需要。 |
OnlyShowLatest | 否 | Boolean | 是否仅最新的镜像;RegistryImageFilter不为空且UpdatedRegistryImageCnt大于0时仓库镜像需要。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量授权镜像扫描V2.0
输入示例
https://tcss.tencentcloudapi.com/?Action=ModifyImageAuthorized
&AllLocalImages=false
&UpdatedLocalImageCnt=1
&LocalImageIds.0=xx
&AllRegistryImages=false
&UpdatedRegistryImageCnt=1
&RegistryImageIds.0=xx
&ImageSourceType=ASSETIMAGE
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "xx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.AuthorizedNotEnough | 授权数不足。 |
InternalError | 内部错误。 |
InternalError.MainDBFail | 操作数据库失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidFormat | 参数格式错误。 |
InvalidParameter.MissingParameter | 缺少必须参数。 |
InvalidParameter.ParsingError | 参数解析错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |