Creates a check and self-healing rule.

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 based on the region where your business is located.

Request method: POST

Request URL: https://vke.cn-beijing.volcengineapi.com?Action=CreateRemedyRule&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 parameter

The following table describes the API request parameters. You also need to provide public parameters when calling this API. For details about public request parameters, see Public parameters.

Parameter	Type	Required	Sample value	Description
Action	String	Yes	CreateRemedyRule	The API name. The API name is CreateRemedyRule.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
Name	String	Yes	Remedy-Node	The name of the check and self-healing rule.
ClusterId	String	Yes	cda5****	Cluster ID. You can call the ListClusters API to obtain cluster IDs.
Rules	Array of RemedyRule	Yes	-	The check and self-healing rule.
ClientToken	String	No	BC028527-33B9-4990-A633-84E9F9****	A string used to ensure the idempotency of the request. This string is passed in by the caller and must be unique across different requests. ClientToken is case-sensitive and can consist of 64 ASCII characters at most.

RemedyRule

Parameter	Type	Required	Sample value	Description
FaultType	String	Yes	NodeFault	The failure type. Valid values: GPUFault: GPU failure NodeFault: Node failure SystemFault: System and add-on failure RegisteredFault: Custom failure XidFault: XID exception
IncidentTypes	Array of String	Yes	["NodeNotReady","NodeFailure"]	The self-healing check item. Different types of failures support different check items. You need to fill in the Kubernetes event here. For details, see Check and self-healing overview.
RemedyStrategy	Object of RemedyStrategy	Yes	-	The check and self-healing policy.

RemedyStrategy

Parameter	Type	Required	Sample value	Description
Type	String	Yes	Remedy	The policy type. Valid values: Notify: Prompt for exception CordonNode: Cordon nodes DrainNode: Drain nodes Remedy: Self-healing Description This parameter can be set to Remedy only if RemedyRule.FaultType is set to RegisteredFault. This parameter can be set to DrainNode or Remedy only if RemedyRule.FaultType is set to XidFault.

Sample requests

Response parameter

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

Parameter	Type	Sample value	Description
Id	String	R202609****	The ID of the check and self-healing rule.

Sample responses

Error code

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

Volcengine Kubernetes Engine