添加用户自定义镜像。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ehpc:AddImage | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ImageType | string | 否 | 镜像类型。取值范围：
| VM |
| Name | string | 是 | 镜像名称。 | app-image |
| ImageVersion | string | 否 | 镜像版本。 | V1.0 |
| Description | string | 否 | 镜像描述。 | 应用测试镜像。 |
| ContainerImageSpec | object | 否 | 容器镜像配置。 | |
| RegistryUrl | string | 否 | 容器镜像访问链接。 | registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest |
| IsACRRegistry | boolean | 否 | 是否为阿里云镜像仓库。
| True |
| IsACREnterprise | boolean | 否 | 是否为阿里云镜像仓库企业版。
| True |
| RegistryCriId | string | 否 | 企业版镜像仓库 ID。 | cri-xyz795ygf8k9**** |
| RegistryCredential | object | 否 | 私有镜像仓库鉴权。 | |
| Server | string | 否 | 镜像仓库的注册地址。 | registry-vpc.cn-hangzhou.aliyuncs.com |
| UserName | string | 否 | 登录用户名。 | username |
| Password | string | 否 | 登录密码。 | userpassword |
| VMImageSpec | object | 否 | 虚拟机镜像配置。 | |
| ImageId | string | 否 | 镜像 ID。 | m-bp1akkkr1rkxtb****** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368\n",
"Success": true,
"ImageId": "m-bp1akkkr1rkxtb******\n"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | 无效的参数：%s |
| 400 | ImageAlreadyExists | The image id already exists. | 镜像已存在 |
| 400 | InDebt | Your account has overdue payments. | 您的账户已欠费 |
| 400 | NotEnabled | You have not enabled this service. | 您的账户还未开通此服务 |
| 403 | ImageInUse | Image is still used by jobs. | 镜像仍在使用中 |
| 404 | ImageNotFound | The specified image does not exist. | 指定的镜像不存在，请您检查该参数是否正确。 |
| 406 | EcsError | An error occurred while calling the ECS API operation. | ECS API调用出错 |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误. %s |
| 406 | DbError | A database error occurred. | 数据库错误 |
| 407 | NotAuthorized | No authorization is granted. | 未授权 |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 请求失败，服务暂时不可用 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-10-23 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |