ListAutoRepairPolicies

Updated at:
Copy as MD

Returns a list of self-healing rules.

Operation description

Important This API will be available in a future release.

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:ListAutoRepairPolicies

none

*Cluster

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

None None

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example

cluster_id

string

No

The cluster ID.

ce0da5a1d627e4e9e9f96cae8ad07****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

Response schema

items

array<object>

A list of auto-repair rules.

array<object>

An auto-repair rule.

name

string

The name of the auto-repair rule.

test

id

string

The ID of the auto-repair rule.

r-xxxxx

resource_type

string

The resource type that the auto-repair rule affects.

nodepool

resource_sub_type

string

The resource sub-type that the auto-repair rule affects.

ess

resource_ids

array

The IDs of the resources that the auto-repair rule affects.

string

A resource ID.

npxxxxx

rules

array<object>

A list of auto-repair sub-rules.

array<object>

An auto-repair sub-rule.

incidents

array<object>

A list of identified incidents.

object

An incident.

name

string

The incident name.

Node.FaultNeedReboot.HOST

type

string

The diagnosis type.

system

repair_procedure

array<object>

The repair procedure.

array<object>

A step in the repair procedure.

name

string

The name of the procedure step.

QuarantineGPU

intervention

object

The manual intervention settings for this procedure step.

enable

boolean

Determines whether manual approval is required for the repair step.

true

type

string

The manual approval type.

label

inquiring_label

object

The configuration for the authorization inquiry label. When this repair step starts, Container Service for Kubernetes (ACK) applies this label to the node and pauses, awaiting approval before executing the step's action.

key

string

The key of the label.

k8s.aliyun.com/incident

value

string

The value of the label.

inquiring

approved_label

object

The configuration for the approval label. Applying this label to the node authorizes Container Service for Kubernetes (ACK) to execute the action for this repair step. After the step is complete, ACK automatically removes both the inquiry and approval labels. If the approval label is not applied promptly, the repair process will not proceed, and the node may remain 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 step.

any

A map of configuration parameters for the repair step.

{ "drain_timeout": "30s" }

Examples

Success response

JSON format

{
  "items": [
    {
      "name": "test",
      "id": "r-xxxxx",
      "resource_type": "nodepool",
      "resource_sub_type": "ess",
      "resource_ids": [
        "npxxxxx"
      ],
      "rules": [
        {
          "incidents": [
            {
              "name": "Node.FaultNeedReboot.HOST",
              "type": "system\n"
            }
          ],
          "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": "{\n\"drain_timeout\": \"30s\" \n}"
              }
            }
          ]
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.