Docs
api
UK8S Service(UK8S)
DescribeUK8SImage

Get Available Images - DescribeUK8SImage

Overview

Obtain the Node operating system supported by UK8S, and you can create custom images based on this operating system.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeUK8SImage.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
ImageSetarray[ImageInfo]Available image set for the virtual machine, see ImageInfo array for details.No
PHostImageSetarray[ImageInfo]Collection of available images for physical machines, see ImageInfo arrayNo

Data Model

ImageInfo

Field NameTypeDescription InformationRequired
ZoneIdintAvailability Zone IdYes
ImageIdstringImage IdYes
ImageNamestringImage NameYes
NotSupportGPUbooleanDoes this image support GPU model, enumeration value [true: not supported, false: supported].Yes

Example

Request Example

https://api.dezai.com/?Action=DescribeUK8SImage
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=sUDxutjf

Response Example

{
  "Action": "DescribeUK8SImageResponse",
  "ImageSet": [
    {
      "ImageId": "SOqcWTEJ",
      "ImageName": "hIscEgwy",
      "NotSupportGPU": false,
      "ZoneId": 5
    }
  ],
  "ImageSetnew": [
    {
      "ImageId": "KeQfHnUL",
      "ImageName": "itWRmsMy",
      "NotSupportGPU": true,
      "ZoneId": 5
    }
  ],
  "Message": "RcXlEGbn",
  "PHostImageSet": [
    {
      "ImageId": "yFeQPFUL",
      "ImageName": "OlgivCjk",
      "NotSupportGPU": true,
      "ZoneId": 9
    }
  ],
  "RetCode": 0
}