Registering a Custom Image
Function
Register a custom image with ModelArts Image Management.
Constraints
None
URI
POST /v1/{project_id}/images
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID and Name. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
arch |
No |
String |
Processor architecture supported by the image. Options:
|
description |
No |
String |
Provides supplementary information about the image. The value contains a maximum of 512 characters. |
origin |
No |
String |
Image source, which defaults to CUSTOMIZE. Options:
|
resource_category |
No |
Array of strings |
Flavors supported by the image. Options:
|
service_type |
No |
String |
Supported image types. Options:
|
services |
No |
Array of strings |
Services supported by the image. Options:
|
swr_path |
No |
String |
SWR image address |
visibility |
No |
String |
Image visibility. Options:
|
workspace_id |
No |
String |
Workspace ID. If no workspaces are available, the default value is 0. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
arch |
String |
Processor architecture supported by the image. Options:
|
create_at |
Long |
Specifies the time (UTC ms) when the image is created. |
description |
String |
Image description with a maximum of 512 characters |
dev_services |
Array of strings |
Services supported by the image. Options:
|
id |
String |
ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format.For details, see Querying Supported Images. |
name |
String |
Image name, which contains a maximum of 512 characters, including lowercase letters, digits, hyphens (-), underscores (_), and periods (.) |
namespace |
String |
Organization to which the image belongs. You can create and view the organization on the Organization Management page of the SWR console. |
origin |
String |
Image source, which defaults to CUSTOMIZE. Options:
|
resource_categories |
Array of strings |
Flavors supported by the image. Options:
|
service_type |
String |
Supported image types. Options:
|
size |
Long |
Specifies the image size, in KB. |
status |
String |
Image status. Options:
|
status_message |
String |
Build information during image saving |
support_res_categories |
Array of strings |
Flavors supported by the image. Options:
|
swr_path |
String |
SWR image address |
tag |
String |
Image tag |
type |
String |
Image type. Options:
|
update_at |
Long |
Specifies the time (UTC ms) when the image was last updated. |
visibility |
String |
Image visibility. Options:
|
workspace_id |
String |
Workspace ID. If no workspaces are available, the default value is 0. |
Example Requests
The following is an example of how to register a custom image whose resource type is CPU and architecture is X86_64.
{ "description" : "", "resource_category" : [ "CPU" ], "arch" : "X86_64", "swr_path" : "swr.xxx.com/op_svc_modelarts_container2/pytorch_1_8:train-pytorch_1.8.0-cuda_10.2-py_3.7" }
Example Responses
Status code: 200
OK
{ "arch" : "x86_64", "create_at" : 1671708630448, "description" : "", "dev_services" : [ "NOTEBOOK", "SSH" ], "id" : "708ca95d-c601-4dc7-86b9-670adfd5e818", "name" : "pytorch_1_8", "namespace" : "op_svc_modelarts_container2", "origin" : "CUSTOMIZE", "resource_categories" : [ "CPU" ], "service_type" : "UNKNOWN", "size" : 3376133259, "status" : "ACTIVE", "swr_path" : "swr.xxx.com/op_svc_modelarts_container2/pytorch_1_8:train-pytorch_1.8.0-cuda_10.2-py_3.7", "tag" : "train-pytorch_1.8.0-cuda_10.2-py_3.7", "type" : "DEDICATED", "update_at" : 1671708630448, "visibility" : "PRIVATE", "workspace_id" : "0" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
201 |
Created |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.