You need to enable JavaScript to run this app.
文档中心
容器服务

容器服务

复制全文
下载 pdf
巡检诊断
ListRemedyConfigs - 查询自愈配置
复制全文
下载 pdf
ListRemedyConfigs - 查询自愈配置
查询自愈配置。​
请求说明​
VKE 已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://vke.cn-beijing.volcengineapi.com?Action=ListRemedyConfigs&Version=2022-05-12​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListRemedyConfigs​
接口名称。当前 API 的名称为 ListRemedyConfigs。​
Version​
String​
是​
2022-05-12​
接口版本。当前 API 的版本为 2022-05-12。​
Filter​
Object of RemedyConfigFilter​
否​
-​
自愈配置。​
PageNumber​
Long​
否​
1​
分页查询时的起始页码,从 1 开始,默认为 1。​
PageSize​
Long​
否​
10​
分页查询时每页显示的记录数,取值:​
  • 最小值:1​
  • 最大值:100​
  • 默认值:10​
​
RemedyConfigFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
Ids​
Array of String​
否​
R202609*****​
检查自愈规则 ID。​
Name​
String​
否​
Remedy-Node​
检查自愈规则名称。​
ClusterIds​
Array of String​
否​
cda5*****​
集群 ID。​
可以调用 ListClusters 接口,获取集群 ID。​
ResourceIds​
Array of String​
否​
["pc51i0*****"]​
节点池 ID。​
可以调用 ListNodePools 接口,获取节点池 ID。​
ResourceType​
String​
否​
VkeNodePool​
绑定的资源类型,当前仅支持 VkeNodePool。​
​
请求示例​
​
POST https://vke.cn-beijing.volcengineapi.com?Action=ListRemedyConfigs&Version=2022-05-12​
Content-Type: application/json​
{​
"Filter": {​
"Ids": [​
""​
],​
"Name": "Remedy-Node",​
"ClusterIds": [​
""​
],​
"ResourceIds": [​
"pc51i0*****"​
],​
"ResourceType": null​
},​
"PageNumber": 1,​
"PageSize": 10​
}
​
返回参数​
本接口返回参数如下表所示,公共返回参数请参见 返回结果。​
​
参数​
类型​
示例值​
描述​
Items​
Array of RemedyConfigResult​
-​
自愈配置列表。​
PageNumber​
Long​
1​
当前页码。​
PageSize​
Long​
10​
每页显示的任务数。​
TotalCount​
Long​
178​
符合查询条件数据总量。​
​
RemedyConfigResult​
​
参数​
类型​
示例值​
描述​
Id​
String​
R2026******​
检查自愈规则 ID。​
Name​
String​
Remedy-Node​
检查自愈规则名称。​
Rules​
Array of RemedyRule​
-​
检查自愈规则。​
ClusterId​
String​
ccbm7****​
集群 ID。​
CreateTime​
String​
2021-01-01T00:00:00Z​
创建时间。​
标准 RFC3339 格式的 UTC+0 时间。​
UpdateTime​
String​
2021-01-01T00:00:00Z​
更新时间。​
标准 RFC3339 格式的 UTC+0 时间。​
ClientToken​
String​
BC028527-33B9-4990-A633-84E9F9xxxx​
用于保证请求幂等性的字符串。该字符串由调用方传入,需保证不同请求之间唯一。ClientToken 对大小写敏感,且最大值不超过 64 个 ASCII 字符。​
ResourceIds​
Array of String​
["pc51i0*****"]​
资源对象 ID 列表。​
ResourceType​
Integer​
VkeNodePool​
绑定的资源类型,当前仅支持 VkeNodePool。​
​
RemedyRule​
​
参数​
类型​
示例值​
描述​
FaultType​
String​
NodeFault​
故障类型。取值:​
  • GPUFault:GPU 故障​
  • NodeFault:节点故障​
  • SystemFault:系统与组件故障​
  • RegisteredFault:自定义故障​
  • XidFault:XID 异常​
IncidentTypes​
Array of String​
["NodeNotReady","NodeFailure"]​
自愈检查项。不同类型的故障支持不同的检查项。此处需填写 Kubernetes Event,详情请参见 检查自愈概述。​
RemedyStrategy​
Object of RemedyStrategy​
-​
检查自愈策略。​
​
RemedyStrategy​
​
参数​
类型​
示例值​
描述​
Type​
String​
Remedy​
策略类型。取值:​
  • Notify:提示异常​
  • CordonNode:封锁节点​
  • DrainNode:排干节点​
  • Remedy:自动修复​
说明​
  • 当RemedyRule.FaultType为RegisteredFault时,仅支持配置为Remedy。​
  • 当RemedyRule.FaultType为XidFault时,仅支持配置为DrainNode或Remedy。​
Config​
Object of StrategyConfig​
-​
自愈策略配置。​
​
StrategyConfig​
​
参数​
类型​
示例值​
描述​
Drain​
Object of DrainConfig​
-​
排干配置。​
Action​
Object of RemedyAction​
-​
自愈动作。​
IaasEvents​
Array of String​
["SystemMaintenance_Redeploy"]​
IaaS 事件过滤。取值:​
  • SystemMaintenance_Redeploy:因系统维护实例重新部署。​
  • InfrastructureUpgrade_Redeploy:因基础设施升级实例重新部署。​
  • SystemFailure_Redeploy:因系统故障实例重新部署。​
  • DiskErrorDetected:硬盘异常。​
  • SystemMaintenance_StopAndRepair:实例停止,系统维修。​
InterveneDrain​
Object of RemedyIntervention​
-​
干预排干。​
InterveneCordon​
Object of RemedyIntervention​
-​
干预禁止调度。​
AutoRestoreSchedule​
Boolean​
true​
是否开启自愈恢复。取值:​
  • true:开启。​
  • false:不开启。​
​
DrainConfig​
​
参数​
类型​
示例值​
描述​
WaitFor​
Integer​
10800​
排干等待时间,单位为秒。​
​
RemedyAction​
​
参数​
类型​
示例值​
描述​
WaitFor​
Integer​
10800​
自愈等待时间,单位为秒。​
RebootEcs​
Boolean​
true​
是否重启 ECS。取值:​
  • true:重启。​
  • false:不重启。​
​
RemedyIntervention​
​
参数​
类型​
示例值​
描述​
Label​
Object of InterventionLabel​
-​
干预标签。​
Enabled​
Boolean​
true​
是否启用干预。取值:​
  • true:开启。​
  • false:不开启。​
​
InterventionLabel​
​
参数​
类型​
示例值​
描述​
Key​
String​
example-key​
标签键。长度限制为 1~256 个字符。​
Value​
String​
example-value​
标签值。长度限制为 0~256 个字符。​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "ListRemedyConfigs",​
"Version": "2022-05-12",​
"Service": "vke",​
"Region": "cn-beijing"​
},​
"Result": {​
"Items": [​
{​
"Id": "R2026******",​
"Name": "Remedy-Node",​
"Rules": [​
{​
"FaultType": "NodeFault",​
"IncidentTypes": [​
"NodeNotReady",​
"NodeFailure"​
],​
"RemedyStrategy": {​
"Type": "Remedy",​
"Config": {​
"Drain": {​
"WaitFor": 10800​
},​
"Action": {​
"WaitFor": 10800,​
"RebootEcs": true​
},​
"IaasEvents": [​
"SystemMaintenance_Redeploy"​
],​
"InterveneDrain": {​
"Label": {​
"Key": "example-key",​
"Value": "example-value"​
},​
"Enabled": true​
},​
"InterveneCordon": {​
"Label": {​
"Key": "example-key",​
"Value": "example-value"​
},​
"Enabled": true​
},​
"AutoRestoreSchedule": true​
}​
}​
}​
],​
"ClusterId": "ccbm7****",​
"CreateTime": "2021-01-01T00:00:00Z",​
"UpdateTime": "2021-01-01T00:00:00Z",​
"ClientToken": "BC028527-33B9-4990-A633-84E9F9xxxx",​
"ResourceIds": [​
"pc51i0*****"​
],​
"ResourceType": null​
}​
],​
"PageNumber": 1,​
"PageSize": 10,​
"TotalCount": 178​
}​
}
​
错误码​
本接口无专有错误码,公共错误码请参见 公共错误码。​
最近更新时间:2026.10.30 11:18:10
这个页面对您有帮助吗?
有用
有用
无用
无用