DescribeAutoRepairPolicy - Container Service for Kubernetes

Queries self-healing rules.

Operation description

Important This API is not yet available.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:DescribeAutoRepairPolicy

none

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request syntax

GET /clusters/{cluster_id}/auto_repair_policies/{policy_id} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
cluster_id	string	No	The ID of the cluster.	c82e6987e2961451182edacd74faf****
policy_id	string	No	The ID of the auto repair policy.	r-xxxxxx

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response schema.
name	string	The name of the auto-healing rule.	test
id	string	The ID of the auto-healing rule.	r-xxx
resource_type	string	The resource type that the auto-healing rule applies to.	nodepool
resource_ids	array	The resource IDs that the auto-healing rule applies to.
	string	The resource ID.	npxxxxx
rules	array<object>	The auto-healing sub-rules.
	array<object>	An auto-healing sub-rule.
incidents	array<object>	The detected faults.
	object	A detected fault.
name	string	The name of the fault.	Node.FaultNeedReboot.HOST
type	string	The type of the fault.	system
repair_procedure	array<object>	The repair procedures.
	array<object>	A repair procedure.
name	string	The name of the procedure.	QuarantineGPU
intervention	object	The configuration for manual intervention.
enable	boolean	Specifies whether to enable manual approval.	true
type	string	The type of manual approval.	label
inquiring_label	object	The configuration of the inquiry label. When a repair procedure reaches this stage, ACK adds this label to the node and awaits your authorization to proceed.
key	string	The key of the label.	k8s.aliyun.com/incident
value	string	The value of the label.	inquiring
approved_label	object	The configuration of the approval label. Add this label to the node to authorize ACK to proceed with the repair. After the action is complete, ACK automatically removes both the inquiry and approval labels for this stage. Failure to add this label promptly will halt the repair procedure, potentially leaving the node in an unhealthy state.
key	string	The `key` of the label.	k8s.aliyun.com/incident
value	string	The value of the label.	approved
config	object	The configuration parameters for the procedure.
	any	The key-value pairs for the procedure configuration.	"drain_timeout": "30s"
resource_sub_type	string	The resource subtype that the auto-healing rule applies to.	ess

Examples

Success response

JSON format

{
  "name": "test",
  "id": "r-xxx",
  "resource_type": "nodepool",
  "resource_ids": [
    "npxxxxx"
  ],
  "rules": [
    {
      "incidents": [
        {
          "name": "Node.FaultNeedReboot.HOST",
          "type": "system"
        }
      ],
      "repair_procedure": [
        {
          "name": "QuarantineGPU",
          "intervention": {
            "enable": true,
            "type": "label",
            "inquiring_label": {
              "key": "k8s.aliyun.com/incident",
              "value": "inquiring"
            },
            "approved_label": {
              "key": "k8s.aliyun.com/incident",
              "value": "approved"
            }
          },
          "config": {
            "key": "\"drain_timeout\": \"30s\" "
          }
        }
      ]
    }
  ],
  "resource_sub_type": "ess"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.