AddImage - 添加镜像

添加自定义镜像到工作空间。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paiimage:AddImagecreate
  • 全部资源
    *

请求语法

POST /api/v1/images HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求结构体。

Namestring

镜像名称。命名规则如下:

  • 长度为 1~50 个英文字符。
  • 支持小写字母、数字和短横线(-),以字母开头。
  • 工作空间内可重复。
nlp-compression
Descriptionstring

镜像的描述信息。

NLP模型压缩训练镜像
ImageUristring

镜像地址,可以重复。关于如何查看镜像地址,详情请参见 ListImage

registry.cn-hangzhou.aliyuncs.com/pai-compression/nlp:gpu
Labelsarray<object>

镜像标签,是个数组,数组每一项包含 key 和 value 两个字段。 官方镜像有如下标签:system.official=true 目前支持添加的键如下:

  • system.chipType
  • system.dsw.cudaVersion
  • system.dsw.fromImageId
  • system.dsw.fromInstanceId
  • system.dsw.id
  • system.dsw.os
  • system.dsw.osVersion
  • system.dsw.resourceType
  • system.dsw.rootImageId
  • system.dsw.stage
  • system.dsw.tag
  • system.dsw.type
  • system.framework
  • system.origin
  • system.pythonVersion
  • system.source
  • system.supported.dlc
  • system.supported.dsw
object

标签。

Keystring

标签的键。

system.chipType
Valuestring

标签的值。

GPU
WorkspaceIdstring

镜像所属的工作空间 ID。如何获取工作空间 ID,请参见 ListWorkspaces

15******45
Accessibilitystring

镜像的可见性,目前支持:

  • PUBLIC:当前工作空间所有成员都可以操作。
  • PRIVATE:只有创建者可以操作。
PUBLIC
Sizeinteger

镜像大小,单位为 GB。

2
ImageIdstring

镜像 Id,如果不填,系统会自动生成。 格式为 image-18 位大小写英文字母或者数字。

image-k83*****cv

返回参数

名称类型描述示例值
object

返回结构体。

RequestIdstring

请求 ID。

5A14FA81-DD4E-******-6343FE44B941
ImageIdstring

镜像 ID。

image-4c62******53uor

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "ImageId": "image-4c62******53uor"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-07-09API 内部配置变更,不影响调用查看变更详情
2023-06-26API 内部配置变更,不影响调用查看变更详情
2022-12-14API 内部配置变更,不影响调用查看变更详情
2022-12-14API 内部配置变更,不影响调用查看变更详情
2022-08-12API 内部配置变更,不影响调用查看变更详情
2021-09-22新增 OpenAPI查看变更详情