创建一个镜像缓存
更新时间 2025-11-21 15:14:04
最近更新时间: 2025-11-21 15:14:04
接口功能介绍
调用该接口创建镜像缓存
接口约束
无
URI
POST /eci/api/v1/imageCache/createImageCache
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 区域ID | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| imageCacheName | 是 | String | 镜像缓存名字 | test | |
| imageCacheSize | 否 | Integer | 镜像缓存大小 ,默认为20G | 20 | |
| retentionDays | 否 | Integer | 镜像缓存保留时间（单位天），不传或传0表示永不过期 ，最大值3650 | 30 | |
| tags | 否 | Array of Objects | 标签 | tag | |
| securityGroupId | 是 | String | 安全组ID | sg-test | |
| vSwitchId | 是 | String | 子网ID | subnet-test | |
| azInfo | 是 | Object | 可用区 | azInfo | |
| imageRegistryCredentials | 否 | Array of Objects | 不带 http:// 或 https:// 前缀的镜像仓库地址 | imageRegistryCredential | |
| images | 是 | Array of Strings | 镜像列表 | ["registry-vpc-crs-huadong1.ctyun.cn/x-eci/base:latest"] | |
| eip | 否 | Object | 弹性公网 IP。如果需要拉取公网镜像，需要确保 ECI 实例能够访问公网，您可以配置 EIP 或者 NAT 网关实现公网访问。 | eip | |
| vpcId | 是 | String | 实例所在VpcId | vpc-ctt6yag121 | |
| 表 tag |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| key | 否 | String | 标签的key | key-test | |
| value | 否 | String | 标签的value | value-test | |
| 表 azInfo |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| azName | 是 | String | az名称 | az1 | |
| 表 imageRegistryCredential |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| server | 是 | String | 服务名称 | chengdu1-az1.crs.ctyun.cn | |
| userName | 是 | String | 用户名 | testuser | |
| password | 是 | String | 镜像凭证密码 | testpwd | |
| 表 eip |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| eipInstanceId | 是 | String | eip 实例ID | az1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 请求成功(200)或失败(非200) | 200 | |
| error | String | 错误码，三段式 | ECI.Openapi.StatusReasonInternalError | |
| message | String | 错误信息描述 | Internal error occurred | |
| returnObj | Object | 返回信息 | returnObj | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| requestId | String | 请求ID | b0a55967-825e-4037-a1e2-c1320485 | |
| imageCacheId | String | 镜像缓存ID | imc-7nh0dkpoaxepqyh2 |
枚举参数
无
请求示例
请求url
POST https://eci-global.ctapi.ctyun.cn/eci/api/v1/imageCache/createImageCache
请求头header
regionId: bb9fdb42056f11eda1610242ac110002
请求体body
{
"securityGroupId": "sg-test",
"vSwitchId": "subnet-test",
"vpcId": "vpc-test",
"imageCacheName": "lztest",
"imageCacheSize": 40,
"retentionDays": 30,
"images": [
"nginx:latest"
],
"tags": [
{
"key": "user",
"value": "eci"
}
],
"azInfo": {
"azName": "az1"
},
"imageRegistryCredentials": [
{
"server": "chengdu1-az1.crs.ctyun.cn",
"userName": "hello",
"password": "world"
}
]
}
响应示例
{
"statusCode": 200,
"returnObj": {
"requestId": "c8584614-daa4-475e-a8c3-113dc8f108c1",
"imageCacheId": "imc-7nh0dkpoaxepqyh2"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
