Query the types of resources for related services supported by VKE.

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=ListSupportedResourceTypes&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.

Go to debug

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.

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListSupportedResourceTypes	The API name. The name of the current API is ListSupportedResourceTypes.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Filter	Object of SupportedResourceTypesFilter	no	-	The filter condition for the resource type to be queried.
PageNumber	Integer	no	1	The starting page number when querying. The default number is 1.
PageSize	Integer	no	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

SupportedResourceTypesFilter

Parameter	Type	Required	Sample value	Description
ZoneIds	Array of String	no	["zone-a"]	The list of availability zone IDs. For availability zone IDs (ZoneID), see Regions and availability zones. tip If you do not specify this parameter, resource information in all availability zones in the specified region is returned.
ResourceTypes	Array of String	no	["Ecs","Zone"]	The returned resource type. Two resource types are supported. Ecs: ECS resources Zone: Availability zone resources If you do not specify this parameter, the API returns all resource types supported by VKE.

Sample requests

Response parameters

The following table contains the response parameters of this API. See Response results for details about public response parameters.

Parameters	Type	Sample value	Description
Items	Array of SupportedResourceTypeResponse	-	The list of supported resource types and specifications.
PageNumber	Integer	1	The current page number.
PageSize	Integer	10	The number of data entries displayed per page.
TotalCount	Integer	11	The total number of data entries that meet the conditions.

SupportedResourceTypeResponse

Parameter	Type	Sample value	Description
ResourceScope	String	Zone	The scope to which the resource belongs. Valid values: Zone: Availability zone Region: Region
ZoneId	String	cn-bei******	The ID of the specific availability zone supported by the resource.
ResourceType	String	Ecs	The resource type. Valid values: Ecs: ECS resources Zone: Availability zone resources
ResourceSpecifications	Array of String	["ecs.g1ie.large"]	The list of specifications that correspond to resources. Currently, only ECS resources are supported. For ECS instance specifications, see the description of the InstanceTypeId parameter of the DescribeInstanceTypes API.

Sample responses

Error code

There are no proprietary error codes for this API. See Public error codes for details.

Volcengine Kubernetes Engine