You need to enable JavaScript to run this app.
Volcengine Kubernetes Engine

Volcengine Kubernetes Engine

Copy page
Download PDF
Instance images management
ListSupportedImages
Copy page
Download PDF
ListSupportedImages
Obtain the list of images supported by ECS instance specifications that correspond to nodes.​
API description​
  • Only Kubernetes clusters v1.30 and later versions support nodes that use veLinux 2.0 or Ubuntu 22.x series images.​
  • veLinux 2.0 and Ubuntu 22.x series images use cgroup v2 by default.​
Request description​
VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point for your business region.​
  • Request method: POST​
  • Request URL: https://vke.cn-beijing.volcengineapi.com?Action=ListSupportedImages&Version=2022-05-12​
Debugging​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
The following table describes the API request parameters. You also need to provide public parameters when calling this API. See Public parameters for details.​
​
Parameter​
Type​
Required​
Sample value​
Description​
Action​
String​
Yes​
ListSupportedImages​
The API name. The name of the current API is ListSupportedImages.​
Version​
String​
Yes​
2022-05-12​
The API version. The current version of the API is 2022-05-12.​
InstanceTypeIds​
Array of String​
Yes​
["ecs.g1ie.large"]​
The IDs of the ECS instance specifications that correspond to nodes. You can call the ListNodePools API to obtain the instance specification IDs. You can specify up to 10 instance specification IDs at a time.​
Intersection​
Boolean​
No​
true​
Whether to obtain the image intersection. Valid values:​
  • true: Returns images supported by ‌all selected instance specifications‌.​
  • false: (Default) Returns images supported by the ‌specified instance specification‌.​
KubernetesVersion​
String​
No​
v1.28.3-vke.1​
The Kubernetes version of the cluster. You can obtain the list of supported images based on the instance specification and Kubernetes version.​
​
Sample requests​
​
POST https://vke.cn-beijing.volcengineapi.com?Action=ListSupportedImages&Version=2022-05-12​
Content-Type: application/json​
{​
"InstanceTypeIds": [​
"ecs.g1ie.**.**.**.**.**.**",​
"ecs.g3ilt.**.**.**.**.**.**"​
],​
"Intersection": false,​
"KubernetesVersion": "v1.28.3-vke.1"​
}​
​
Response parameters​
The following table contains the response parameters of this API. See Response results for details about public response parameters.​
​
Parameter​
Type​
Sample value​
Description​
Items​
-​
The list of returned image information.​
IntersectionItems​
Array of ImageResponse​
-​
The image intersection list.​
​
SupportedImagesResponse​
​
Parameter​
Type​
Sample value​
Description​
InstanceTypeId​
String​
ecs.g1i*******​
The ID of the node specification.​
SupportedImages​
Array of ImageResponse​
-​
The list of images supported by instance specifications that correspond to nodes.​
​
ImageResponse​
​
Parameter​
Type​
Sample value​
Description​
ImageId​
String​
img-1******​
The image ID.​
ImageName​
String​
ubuntu-20.04​
Image name.​
​
Sample responses​
​
{​
"ResponseMetadata": {​
"RequestId": "202306041104********",​
"Action": "ListSupportedImages",​
"Version": "2022-05-12",​
"Service": "vke",​
"Region": "cn-beijing"​
},​
"Result": {​
"Items": [​
{​
"InstanceTypeId": "ecs.g1i*******",​
"SupportedImages": [​
{​
"ImageId": "img-1*****",​
"ImageName": "ubuntu-20.04"​
},​
{​
"ImageId": "img-3*****",​
"ImageName": "ubuntu-20.04"​
}​
]​
},​
{​
"InstanceTypeId": "ecs.g3i********",​
"SupportedImages": [​
{​
"ImageId": "img-3*****",​
"ImageName": "ubuntu-20.04"​
}​
]​
}​
]​
}​
}​
​
Error code​
There are no proprietary error codes for this API. See Public error codes for details about public error codes.​
Last updated: 2026.05.26 20:00:13