ListCustomImages - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListCustomImages	The operation that you want to perform. Set the value to ListCustomImages.
ImageOwnerAlias	String	No	self	The source of the image. Valid values: self: custom image others: shared image
BaseOsTag	String	No	CentOS_7.2_64	The image tag of the base operating system. The tag is used only by the management node.
InstanceType	String	No	ecs.n1.tiny	Specify the type of the instance. By default, if you do not specify the type of the instance, the list of images that are supported by all the instance types are queried.
ClusterId	String	No	ehpc-hz-FYUr32****	The ID of the cluster where the application resides. If the cluster supports multiple operating systems, all the images in the region where the cluster resides are queried. By default, if you do not specify the cluster ID, the images that are supported by all the clusters is queried.

Response parameters


Parameter	Type	Example	Description
Images	Array of ImageInfo		The list of custom images and shared images that are supported by the E-HPC.
ImageInfo
BaseOsTag	Struct		The image tag of the base operating system.
Architecture	String	i386	The architecture of the operating system. Valid values: i386 x86_64
OsTag	String	CentOS_7.2_64	The image tag of the operating system.
Platform	String	CentOS	The release version of the operating system. Valid values: CentOS Ubuntu SUSE OpenSUSE Debian CoreOS Aliyun Windows Server 2003 Windows Server 2008 Windows Server 2012 Others Linux Customized Linux
Version	String	7.2	The version number of the operating system.
Description	String	ExampleDescription	The description of the image.
ImageId	String	m-bp181x855551ww5yq****	The ID of the image.
ImageName	String	CHESS5V5.0.27	The name of the image.
ImageOwnerAlias	String	self	The type of image. Valid values: self: custom image others: shared image
OsTag	Struct		An array of system images that are supported by E-HPC.
Architecture	String	x86_64	The architecture of the operating system. Valid values: i386 x86_64
BaseOsTag	String	CentOS_7.2_64	The image tag of the base operating system.
OsTag	String	CentOS_7.2_64	The image tag of the operating system.
Platform	String	CentOS	The platform of the operating system.
Version	String	7.2	The version of the operating system.
PostInstallScript	String	example.sh	The script that is run after the image is installed.
PricingCycle	String	Month	The billing unit of the image. Valid values: Hour Month Year
ProductCode	String	cmjj028279	The product code on Alibaba Cloud Marketplace.
Size	Integer	40	The size of the image. Unit: GiB
SkuCode	String	ECS	The stock keeping unit (SKU) of the image. Valid values: -ECS: pay-as-you-go -package: subscription
Status	String	Available	The status of the image. Valid values: UnAvailable: The image is unavailable. Available: The image is available. Creating: The image is being created. CreateFailed: The image has failed to be created.
Uid	String	127****	The owner of the image.
RequestId	String	04F0F334-1335-436C-A1D7-6C044FE73368	The ID of the request.

Examples

Sample requests

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListCustomImages
&<Common request parameters>

Sample responses

XML format

<ListCustomImagesResponse>
      <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
      <PricingCycle>Month</PricingCycle>
      <Status>Available</Status>
      <ImageId>m-bp1h8aoe73p71iow****</ImageId>
      <Description></Description>
      <ImageName>CHESS5V5.0.27</ImageName>
      <ProductCode>cmjj028279</ProductCode>
      <ImageOwnerAlias>marketplace</ImageOwnerAlias>
      <Uid>127****</Uid>
      <Size>40</Size>
      <SkuCode>ECS</SkuCode>
      <BaseOsTag>
            <Architecture>x86_64</Architecture>
            <Version>7.2</Version>
            <Platform>CentOS</Platform>
            <OsTag>CentOS_7.2_64</OsTag>
            <BaseOsTag>CentOS_7.2_64</BaseOsTag>
      </BaseOsTag>
      <OsTag>
            <Architecture>x86_64</Architecture>
            <Version>7.2</Version>
            <Platform>CentOS</Platform>
            <OsTag>CentOS_7.2_64</OsTag>
      </OsTag>
</ListCustomImagesResponse>

JSON format

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
    "PricingCycle": "Month",
    "Status": "Available",
    "ImageId": "m-bp1h8aoe73p71iow****",
    "Description": "",
    "ImageName": "CHESS5V5.0.27",
    "ProductCode": "cmjj028279",
    "ImageOwnerAlias": "marketplace",
    "Uid": "127****",
    "Size": "40",
    "SkuCode": "ECS",
    "BaseOsTag": {
        "Architecture": "x86_64",
        "Version": "7.2",
        "Platform": "CentOS",
        "OsTag": "CentOS_7.2_64",
        "BaseOsTag": "CentOS_7.2_64"
    },
     "OsTag": 
        {
            "Architecture": "x86_64",
            "Version": "7.2",
            "Platform": "CentOS",
            "OsTag": "CentOS_7.2_64"
        }
}

Error codes


HttpCode	Error code	Error message	Description
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The error message returned because the request has failed. The server is temporarily unavailable.

For a list of error codes, visit the API Error Center.