Help Center/ Workspace/ API Reference/ Workspace APIs/ Image/ Obtaining KooGallery Images

Updated on 2025-07-14 GMT+08:00

View PDF

Obtaining KooGallery Images

Function

Obtains KooGallery images.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/market-images

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
image_ids	Yes	Array of strings	Image ID. 1 to 100 image IDs are allowed.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
images	Array of Image objects	Image information list.

**Table 5** Image
Parameter	Type	Description
image_id	String	Image ID.
min_disk	Integer	Minimum disk space (GB) required for running the image. The value ranges from 40 to 1,024.
created_at	String	Creation time (UTC) in the format of yyyy-MM-ddTHH:mm:ssZ.
image_size	String	Size of the image file, in byte.
updated_at	String	Update time (UTC) in the format of yyyy-MM-ddTHH:mm:ssZ.
product_code	String	Product ID of a KooGallery image.
max_ram	String	Maximum memory (MB) of the image. The parameter value depends on the ECS specifications and is not configured.
market_resource_type_code	String	KooGallery resource type code.
min_ram	Integer	Minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications and defaults to 0.
os_type	String	OS type: Linux, Windows, or Other.
image_type	String	Image type. The value can be gold (public image), private (private image), or shared (shared image).
tags	Array of strings	Image tags.
platform	String	Image platform type.
os_bit	String	OS architecture, 32-bit or 64-bit.
os_version	String	OS version.
name	String	Image name.
market_service_type_code	String	KooGallery service type code.
status	String	Image status.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

None

Example Responses

Status code: 200

Response to the request for obtaining KooGallery images.

{
  "images" : [ {
    "image_id" : "string",
    "min_disk" : 0,
    "created_at" : "2023-09-21T01:12:11Z",
    "image_size" : "string",
    "updated_at" : "2023-09-21T12:00:44Z",
    "product_code" : "string",
    "max_ram" : "string",
    "market_resource_type_code" : "string",
    "min_ram" : 0,
    "os_type" : "string",
    "image_type" : "string",
    "tags" : [ "string" ],
    "platform" : "string",
    "os_bit" : "string",
    "os_version" : "string",
    "name" : "string",
    "market_service_type_code" : "string",
    "status" : "string"
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for obtaining KooGallery images.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
500	Internal server error.