1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
创建镜像缓存的接口。创建过程中,请勿删除EKSCI实例和云盘,否则镜像缓存将创建失败。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateImageCache。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Images.N | 是 | Array of String | 用于制作镜像缓存的容器镜像列表 示例值:"" |
SubnetId | 是 | String | 实例所属子网 ID 示例值:"" |
VpcId | 是 | String | 实例所属 VPC ID 示例值:"" |
ImageCacheName | 否 | String | 镜像缓存名称 示例值:"" |
SecurityGroupIds.N | 否 | Array of String | 安全组 ID 示例值:"" |
ImageRegistryCredentials.N | 否 | Array of ImageRegistryCredential | 镜像仓库凭证数组 示例值:"" |
ExistedEipId | 否 | String | 用来绑定容器实例的已有EIP 示例值:"" |
AutoCreateEip | 否 | Boolean | 是否为容器实例自动创建EIP,默认为false。若传true,则此参数和ExistedEipIds互斥 示例值:"" |
AutoCreateEipAttribute | 否 | EipAttribute | 自动创建EIP的可选参数。若传此参数,则会自动创建EIP。 另外此参数和ExistedEipIds互斥 示例值:"" |
ImageCacheSize | 否 | Integer | 镜像缓存的大小。默认为20 GiB。取值范围参考云硬盘类型中的高性能云盘类型的大小限制。 示例值:"" |
RetentionDays | 否 | Integer | 镜像缓存保留时间天数,过期将会自动清理,默认为0,永不过期。 示例值:"" |
RegistrySkipVerifyList.N | 否 | Array of String | 指定拉取镜像仓库的镜像时不校验证书。如["harbor.example.com"]。 示例值:"" |
RegistryHttpEndPointList.N | 否 | Array of String | 指定拉取镜像仓库的镜像时使用 HTTP 协议。如["harbor.example.com"]。 示例值:"" |
ResolveConfig | 否 | String | 自定义制作镜像缓存过程中容器实例的宿主机上的 DNS。如: "nameserver 4.4.4.4\nnameserver 8.8.8.8" 示例值:"" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ImageCacheId | String | 镜像缓存Id 示例值:[] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建镜像缓存
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateImageCache
<公共请求参数>
{
"VpcId": "vpc-508ctkfb",
"SubnetId": "subnet-8ah75lo8",
"Images": [
"nginx:latest"
],
"ImageCacheSize": 50
}
输出示例
{
"Response": {
"RequestId": "232323-5ed9-4cb7-9194-a95e2cd626e5",
"ImageCacheId": "imc-xxx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |