Creates an inspection policy.

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=CreateInspectionPolicy&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	CreateInspectionPolicy	The API name. The API name is CreateInspectionPolicy.
Version	String	Yes	May 12, 2022	The API version. The API version is 2022-05-12.
Name	String	No	policy-test	The inspection policy name. It can contain uppercase and lowercase letters, Chinese characters, digits, and hyphens (-). It can be 2 to 64 characters in length.
ClusterId	String	No	ccbm*****	Cluster ID. You can call the ListClusters API to obtain cluster IDs.
ResourceType	String	Yes	VkeCluster	The inspection object type. You can only set the value to VkeCluster, which indicates a cluster inspection.
ResourceIds	Array of String	No	["ccbm7**", "ccdhm**"]	The inspection object IDs.
Type	String	Yes	ClusterInspection	The inspection type. You can only set the value to ClusterInspection, which indicates that a regular inspection is initiated for the inspection object.
Enabled	Boolean	No	true	Whether the inspection policy is enabled. Valid values: true: The policy is enabled. false: The policy is disabled.
Schedule	String	No	0 0 13 * 5	The inspection schedule in standard crontab format. For example, 0 0 13 * 5 means it will be executed at midnight on the 13th of every month and every Friday.
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.

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	R2026******	The inspection policy ID.

Sample responses

Error code

This API has no API-specific error codes. For details about common error codes, see Common error codes.

Volcengine Kubernetes Engine