Add a custom image.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ehpc:AddImage | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ImageType | string | No | The type of the images. Valid values:
| VM |
| Name | string | Yes | The name of the custom image. | app-image |
| ImageVersion | string | No | The version of the image. | V1.0 |
| Description | string | No | The description of the image. | Test image |
| ContainerImageSpec | object | No | The configurations of the container image. | |
| RegistryUrl | string | No | The endpoint of the container image. | registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest |
| IsACRRegistry | boolean | No | Whether it is an Alibaba Cloud image repository.
| True |
| IsACREnterprise | boolean | No | Whether the instance is an Alibaba Cloud image repository Enterprise Edition.
| True |
| RegistryCriId | string | No | The ID of the Container Registry Enterprise Edition image repository. | cri-xyz795ygf8k9**** |
| RegistryCredential | object | No | The authentication of the private image repository. | |
| Server | string | No | The registered address of the image repository. | registry-vpc.cn-hangzhou.aliyuncs.com |
| UserName | string | No | The username of the logon user. | username |
| Password | string | No | The password of the logon user. | userpassword |
| VMImageSpec | object | No | The image configuration of the virtual machine. | |
| ImageId | string | No | The image ID. | m-bp1akkkr1rkxtb****** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368\n",
"Success": true,
"ImageId": "m-bp1akkkr1rkxtb******\n"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParams | The specified parameter %s is invalid. | The specified parameter %s is invalid. |
| 400 | ImageAlreadyExists | The image id already exists. | Mirror already exists |
| 400 | InDebt | Your account has overdue payments. | Your account has overdue payments. |
| 400 | NotEnabled | You have not enabled this service. | You have not enabled this service |
| 403 | ImageInUse | Image is still used by jobs. | Mirror still in use |
| 404 | ImageNotFound | The specified image does not exist. | The specified image does not exist. Please verify the parameter. |
| 406 | EcsError | An error occurred while calling the ECS API operation. | An error occurred while calling the ECS API operation. |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | Alibaba Cloud product error. %s |
| 406 | DbError | A database error occurred. | A database error occurred. |
| 407 | NotAuthorized | No authorization is granted. | No authorization is granted. |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | The request has failed due to a temporary failure of the server. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-23 | The Error code has changed. The request parameters of the API has changed | View Change Details |
