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

容器服务

复制全文
下载 pdf
巡检诊断
ListInspectionPolicies - 查询巡检策略列表
复制全文
下载 pdf
ListInspectionPolicies - 查询巡检策略列表
查询巡检策略列表。​
请求说明​
VKE 已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://vke.cn-beijing.volcengineapi.com?Action=ListInspectionPolicies&Version=2022-05-12​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
调用该 API 时的请求参数如下,除此之外还需传入公共请求参数。公共请求参数说明,请参见 公共参数。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListInspectionPolicies​
接口名称。当前 API 的名称为 ListInspectionPolicies。​
Version​
String​
是​
2022-05-12​
接口版本。当前 API 的版本为 2022-05-12。​
Filter​
否​
-​
巡检策略过滤,对各查询参数的取值范围取交集,返回匹配结果。​
PageNumber​
Long​
否​
1​
分页查询时的起始页码,从 1 开始,默认为 1。​
PageSize​
Long​
否​
10​
分页查询时每页显示的记录数,取值:​
  • 最小值:1​
  • 最大值:100​
  • 默认值:10​
​
InspectionConfigFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
Ids​
Array of String​
否​
R202604****​
巡检策略 ID。​
Name​
String​
否​
policy-test​
巡检策略名称。​
Types​
Array of String​
否​
ClusterInspection​
巡检类型,当前仅支持配置为 ClusterInspection ,表示面向巡检对象发起普通巡检。​
ClusterIds​
Array of String​
否​
ccbm7****​
集群 ID。​
可以调用 ListClusters 接口,获取集群 ID。​
ResourceIds​
Array of String​
否​
["ccbm7****", "ccdhm****"]​
巡检对象 ID 列表。​
ResourceType​
String​
否​
VkeCluster​
巡检对象类型,当前仅支持配置为 VkeCluster,表示集群巡检。​
​
请求示例​
​
POST https://vke.cn-beijing.volcengineapi.com?Action=ListInspectionPolicies&Version=2022-05-12​
Content-Type: application/json​
{​
"Filter": {​
"Ids": [​
""​
],​
"Name": "policy-test",​
"Types": [​
""​
],​
"ClusterIds": [​
"ccbm7****"​
],​
"ResourceIds": [​
"ccbm7****",​
"ccdhm****"​
],​
"ResourceType": "VkeCluster"​
},​
"PageNumber": 1,​
"PageSize": 10​
}​
​
返回参数​
本接口返回参数如下表所示,公共返回参数请参见 返回结果。​
​
参数​
类型​
示例值​
描述​
Items​
-​
巡检自愈配置列表。​
PageNumber​
Long​
1​
当前页码。​
PageSize​
Long​
10​
每页显示的任务数。​
TotalCount​
Long​
178​
符合查询条件数据总量。​
​
InspectionConfigResult​
​
参数​
类型​
示例值​
描述​
Id​
String​
R2026******​
巡检策略 ID。​
Name​
String​
policy-test​
巡检策略名称。​
Type​
String​
ClusterInspection​
巡检类型,当前仅支持配置为 ClusterInspection ,表示面向巡检对象发起普通巡检。​
Enabled​
Boolean​
true​
巡检策略是否开启。取值:​
  • true:开启​
  • false:不开启​
Schedule​
String​
0 0 13 * 5​
巡检计划,需使用标准的 crontab 命令。例如, 0 0 13 * 5表示每月13 号和每周的星期五零点都会执行。​
ClusterId​
String​
ccbm*****​
集群 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​
["ccbm7****", "ccdhm****"]​
巡检对象 ID 列表。​
ResourceType​
String​
VkeCluster​
巡检对象类型,当前仅支持配置为 VkeCluster,表示集群巡检。​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202306041104********",​
"Action": "ListInspectionPolicies",​
"Version": "2022-05-12",​
"Service": "vke",​
"Region": "cn-beijing"​
},​
"Result": {​
"Items": [​
{​
"Id": "R2026******",​
"Name": "policy-test",​
"Type": "ClusterInspection",​
"Enabled": true,​
"Schedule": "0 0 13 * 5",​
"ClusterId": "ccbm*****",​
"CreateTime": "2021-01-01T00:00:00Z",​
"UpdateTime": "2021-01-01T00:00:00Z",​
"ClientToken": "BC028527-33B9-4990-A633-84E9F9xxxx",​
"ResourceIds": [​
"ccbm7****",​
"ccdhm****"​
],​
"ResourceType": "VkeCluster"​
}​
],​
"PageNumber": 1,​
"PageSize": 10,​
"TotalCount": 178​
}​
}​
​
错误码​
本接口无专有错误码,公共错误码请参见 公共错误码。​
​
最近更新时间:2026.09.21 19:54:20
这个页面对您有帮助吗?
有用
有用
无用
无用