根据指定配置构建自定义镜像， 构建成功后，会添加到当前工作空间的自定义镜像里。
接口说明
请求说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/imagebuilds HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientToken |
string |
否 |
幂等参数 |
123e4567-e89b-12d3-a456-426655440000 |
| body |
object |
否 |
body 参数 |
|
| Accessibility |
string |
否 |
可见性
枚举值：
|
PUBLIC |
| WorkspaceId |
string |
是 |
工作空间 ID。 |
12345 |
| Resource |
object |
是 |
任务运行资源 |
|
| EcsSpec |
string |
否 |
后付费资源规格。使用“公共资源组”时，此参数必填。 |
ecs.c6.large |
| ResourceConfig |
object |
否 |
资源配置。使用预付费资源时需要指定，使用“公共资源组”时为空。 |
|
| CPU |
string |
否 |
CPU 核心数 |
4 |
| Memory |
string |
否 |
内存容量。 |
8Gi |
| ResourceId |
string |
否 |
资源配额 ID。仅针对预付费资源，使用后付费资源时不设置。 |
quotaadzoqup693z |
| ResourceType |
string |
否 |
预付费资源类型。目前只支持灵骏资源，使用预付费资源时需要指定。 枚举值：
|
Lingjun |
| UserVpc |
object |
否 |
用户专有网络信息。使用“公共资源组”时，此参数必填。 |
|
| VpcId |
string |
否 |
专有网络 ID。构建任务访问用户企业版 ACR 实例时，需要指定在用户 ACR 实例的访问控制里已添加的专有网络。 |
vpc-abcdef** |
| SwitchId |
string |
否 |
交换机 ID，可选。 |
vs-abcdef** |
| SecurityGroupId |
string |
否 |
安全组 ID。指定专有网络配置时，此参数必填。 |
sg-abcdef** |
| ExtendedCidrs |
array |
否 |
扩展网段。
|
|
|
string |
否 |
扩展网段 |
10.0.0.0/24 |
|
| DefaultRoute |
string |
否 |
默认路由。
|
eth1 |
| TargetRegistry |
object |
是 |
目标镜像服务配置。 |
|
| InstanceId |
string |
否 |
镜像服务实例 ID。 使用 ACR 作为镜像服务时，此参数必填。 |
cri-**abcd |
| Type |
string |
是 |
当前只支持企业版 ACR 作为目标镜像服务。 |
AcrEnterprise |
| OverwriteImageTag |
boolean |
否 |
是否覆盖更新镜像仓库中已经存在的镜像版本。 |
|
| BuildConfig |
object |
是 |
构建配置，指定待构建的 Dockerfile 文件内容。 |
|
| Dockerfile |
string |
是 |
指定待构建的 Dockerfile 文件内容。 |
FROM ubuntu:18:04 RUN pip3 install numpy==1.19.5 |
| BuildType |
string |
是 |
构建类型，当前支持以下两种类型：
|
PackageInstallation |
| RegistryAuths |
object |
否 |
私有镜像仓库鉴权信息。可以指定非当前用户的 ACR 镜像仓库的鉴权信息，格式：{"user_registry_domain":{"Auth":"base64 encoded auth"}} |
{ "user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com": { "Auth": "dXNlcjp0ZXN0" } } |
| RegionId |
string |
否 |
地域 ID |
cn-wulanchabu |
| ImageBuildJobName |
string |
否 |
镜像构建任务名称。 |
build-my-image |
| Image |
object |
是 |
镜像元数据信息。 |
|
| Name |
string |
是 |
命名规则如下：
|
test-v1 |
| Description |
string |
否 |
镜像描述。 |
构建测试镜像 |
| Uri |
string |
是 |
镜像地址。 |
user-test-registry-vpc.cn-wulanchabu.cr.aliyuncs.com/pai-test/pai-test:test-v1 |
| Labels |
array<object> |
否 |
镜像标签。 |
|
|
object |
否 |
|||
| Key |
string |
否 |
镜像标签的键。 |
key1 |
| Value |
string |
否 |
镜像标签的值。 |
value1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回值都是 json 格式 |
||
| ImageBuildId |
string |
镜像构建 ID。 |
build-****ks92 |
| ImageBuildJobId |
string |
构建任务 ID。 |
dlc-****ks92 |
示例
正常返回示例
JSON格式
{
"ImageBuildId": "build-****ks92",
"ImageBuildJobId": "dlc-****ks92"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。