Fleet API
编辑Fleet API编辑
此功能处于技术预览阶段,可能会在未来版本中更改或删除。Elastic 将努力解决任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。
方法
[ 跳转到 模型 ]目录
Agent 操作
post /agents/{agentId}/actions/{actionId}/cancel
get /agents/action_status
post /agents/{agentId}/actions
Agent 二进制下载源
delete /agent_download_sources/{sourceId}
get /agent_download_sources
get /agent_download_sources/{sourceId}
post /agent_download_sources
put /agent_download_sources/{sourceId}
Agent 策略
post /agent_policies/{agentPolicyId}/copy
get /agent_policies/{agentPolicyId}/download
get /agent_policies/{agentPolicyId}/full
get /agent_policies/{agentPolicyId}
get /agent_policies
post /agent_policies/_bulk_get
post /agent_policies
post /agent_policies/delete
put /agent_policies/{agentPolicyId}
Agent 状态
Agents
post /agents/bulk_reassign
post /agents/bulk_request_diagnostics
post /agents/bulk_unenroll
post /agents/bulk_update_agent_tags
post /agents/bulk_upgrade
delete /agents/{agentId}
get /agents/{agentId}
get /agents/tags
get /agents/files@{fileId}@{fileName}
get /agents
post /agents
get /agents/setup
get /agents/{agentId}/uploads
post /agents/{agentId}/reassign
put /agents/{agentId}/reassign
post /agents/{agentId}/request_diagnostics
post /agents/setup
post /agents/{agentId}/unenroll
put /agents/{agentId}
post /agents/{agentId}/upgrade
数据流
Elastic 包管理器 EPM
post /epm/bulk_assets
post /epm/packages/_bulk
delete /epm/packages/{pkgName}/{pkgVersion}
delete /epm/packages/{pkgkey}
get /epm/packages/{pkgName}/{pkgVersion}
get /epm/categories
get /epm/packages/{pkgkey}
get /epm/packages/{pkgName}/stats
post /epm/packages/{pkgName}/{pkgVersion}
post /epm/packages
post /epm/packages/{pkgkey}
get /epm/packages
get /epm/packages/limited
get /epm/packages/{pkgName}/{pkgVersion}/{filePath}
get /epm/verification_key_id
put /epm/packages/{pkgName}/{pkgVersion}
注册 API 密钥
post /enrollment_api_keys
post /enrollment-api-keys
delete /enrollment_api_keys/{keyId}
delete /enrollment-api-keys/{keyId}
get /enrollment_api_keys/{keyId}
get /enrollment-api-keys/{keyId}
get /enrollment_api_keys
get /enrollment-api-keys
Fleet 内部
Fleet 服务器主机
delete /fleet_server_hosts/{itemId}
get /fleet_server_hosts
get /fleet_server_hosts/{itemId}
post /fleet_server_hosts
put /fleet_server_hosts/{itemId}
Kubernetes
输出
delete /outputs/{outputId}
post /logstash_api_keys
get /outputs/{outputId}
get /outputs
post /outputs
put /outputs/{outputId}
软件包策略
post /package_policies/_bulk_get
post /package_policies
delete /package_policies/{packagePolicyId}
get /package_policies
get /package_policies/{packagePolicyId}
post /package_policies/delete
put /package_policies/{packagePolicyId}
post /package_policies/upgrade
post /package_policies/upgrade/dryrun
代理
服务令牌
Agent 操作
编辑取消 Agent 操作 (agentActionCancel)
路径参数
agentId(必填)
路径参数 — 默认值:null
actionId(必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{ }
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agent_action_cancel_200_response400
一般错误 fleet_server_health_check_400_response获取 Agent 操作状态 (agentsActionStatus)
查询参数
perPage(可选)
查询参数 — 要返回的项目数,默认值:20
page(可选)
查询参数 — 默认值:1
errorSize(可选)
查询参数 — 默认值:5
返回类型
示例数据
Content-Type: application/json
{
"items" : [ {
"nbAgentsActioned" : 0.8008281904610115,
"creationTime" : "creationTime",
"cancellationTime" : "cancellationTime",
"latestErrors" : [ {
"agentId" : "agentId",
"error" : "error",
"timestamp" : "timestamp"
}, {
"agentId" : "agentId",
"error" : "error",
"timestamp" : "timestamp"
} ],
"type" : "POLICY_REASSIGN",
"newPolicyId" : "newPolicyId",
"version" : "version",
"revision" : "revision",
"completionTime" : "completionTime",
"policyId" : "policyId",
"actionId" : "actionId",
"nbAgentsAck" : 1.4658129805029452,
"nbAgentsFailed" : 5.962133916683182,
"startTime" : "startTime",
"expiration" : "expiration",
"nbAgentsActionCreated" : 6.027456183070403,
"status" : "COMPLETE"
}, {
"nbAgentsActioned" : 0.8008281904610115,
"creationTime" : "creationTime",
"cancellationTime" : "cancellationTime",
"latestErrors" : [ {
"agentId" : "agentId",
"error" : "error",
"timestamp" : "timestamp"
}, {
"agentId" : "agentId",
"error" : "error",
"timestamp" : "timestamp"
} ],
"type" : "POLICY_REASSIGN",
"newPolicyId" : "newPolicyId",
"version" : "version",
"revision" : "revision",
"completionTime" : "completionTime",
"policyId" : "policyId",
"actionId" : "actionId",
"nbAgentsAck" : 1.4658129805029452,
"nbAgentsFailed" : 5.962133916683182,
"startTime" : "startTime",
"expiration" : "expiration",
"nbAgentsActionCreated" : 6.027456183070403,
"status" : "COMPLETE"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agents_action_status_200_response400
一般错误 fleet_server_health_check_400_response创建 Agent 操作 (newAgentAction)
路径参数
agentId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
new_agent_action_request new_agent_action_request (必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"headers" : "headers",
"body" : [ 0.8008281904610115, 0.8008281904610115 ],
"statusCode" : 6.027456183070403
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK new_agent_action_200_response400
一般错误 fleet_server_health_check_400_responseAgent 二进制下载源
编辑按 ID 删除 Agent 二进制下载源 (deleteDownloadSource)
路径参数
sourceId(必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"id" : "id"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK delete_package_policy_200_response400
一般错误 fleet_server_health_check_400_response列出 Agent 二进制下载源 (getDownloadSources)
返回类型
示例数据
Content-Type: application/json
{
"total" : 0,
"perPage" : 1,
"page" : 6,
"items" : [ {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}, {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK get_download_sources_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取 Agent 二进制下载源 (getOneDownloadSource)
路径参数
sourceId(必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK get_one_download_source_200_response400
一般错误 fleet_server_health_check_400_response创建 Agent 二进制下载源 (postDownloadSources)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
post_download_sources_request post_download_sources_request (可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK post_download_sources_200_response400
一般错误 fleet_server_health_check_400_response按 ID 更新 Agent 二进制下载源 (updateDownloadSource)
路径参数
sourceId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
update_download_source_request update_download_source_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"name" : "name",
"host" : "host",
"id" : "id",
"is_default" : true
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK get_one_download_source_200_response400
一般错误 fleet_server_health_check_400_responseAgent 策略
编辑按 ID 复制 Agent 策略 (agentPolicyCopy)
路径参数
agentPolicyId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
agent_policy_copy_request agent_policy_copy_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agent_policy_info_200_response400
一般错误 fleet_server_health_check_400_response按 ID 下载 Agent 策略 (agentPolicyDownload)
路径参数
agentPolicyId(必填)
路径参数 — 默认值:null
查询参数
download(可选)
查询参数 — 默认值:null
standalone(可选)
查询参数 — 默认值:null
kubernetes(可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : "item"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agent_policy_download_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取完整的 Agent 策略 (agentPolicyFull)
路径参数
agentPolicyId(必填)
路径参数 — 默认值:null
查询参数
download(可选)
查询参数 — 默认值:null
standalone(可选)
查询参数 — 默认值:null
kubernetes(可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{ }
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agent_policy_full_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取 Agent 策略 (agentPolicyInfo)
获取一个 Agent 策略
路径参数
agentPolicyId(必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agent_policy_info_200_response400
一般错误 fleet_server_health_check_400_response列出 Agent 策略 (agentPolicyList)
查询参数
perPage(可选)
查询参数 — 要返回的项目数,默认值:20
page(可选)
查询参数 — 默认值:1
kuery(可选)
查询参数 — 默认值:null
full(可选)
查询参数 — 如果设置为 true,则检索每个代理策略的相关包策略。默认值:null
noAgentCount(可选)
查询参数 — 如果设置为 true,则不计算代理策略中的代理数量,如果要搜索大量代理策略,这可以提高性能。如果设置为 true,“agents”属性将始终为 0。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"total" : 5.637376656633329,
"perPage" : 7.061401241503109,
"page" : 2.3021358869347655,
"items" : [ {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
}, {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 agent_policy_list_200_response400
一般错误 fleet_server_health_check_400_response批量获取代理策略 (bulkGetAgentPolicies)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_get_agent_policies_request bulk_get_agent_policies_request(可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
{
"items" : [ {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
}, {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_get_agent_policies_200_response400
一般错误 fleet_server_health_check_400_response创建代理策略 (createAgentPolicy)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
agent_policy_create_request agent_policy_create_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 create_agent_policy_200_response400
一般错误 fleet_server_health_check_400_response按 ID 删除代理策略 (deleteAgentPolicy)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
delete_agent_policy_request delete_agent_policy_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"success" : true,
"id" : "id"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 delete_agent_policy_200_response400
一般错误 fleet_server_health_check_400_response按 ID 更新代理策略 (updateAgentPolicy)
路径参数
agentPolicyId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
agent_policy_update_request agent_policy_update_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"updated_on" : "2000-01-23T04:56:07.000+00:00",
"package_policies" : [ null, null ],
"agent_features" : [ {
"name" : "name",
"enabled" : true
}, {
"name" : "name",
"enabled" : true
} ],
"description" : "description",
"fleet_server_host_id" : "fleet_server_host_id",
"monitoring_output_id" : "monitoring_output_id",
"inactivity_timeout" : 6.027456183070403,
"overrides" : "{}",
"download_source_id" : "download_source_id",
"is_protected" : true,
"revision" : 1.4658129805029452,
"agents" : 5.962133916683182,
"monitoring_enabled" : [ "metrics", "metrics" ],
"name" : "name",
"namespace" : "namespace",
"updated_by" : "updated_by",
"data_output_id" : "data_output_id",
"id" : "id",
"unenroll_timeout" : 0.8008281904610115
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agent_policy_info_200_response400
一般错误 fleet_server_health_check_400_responseAgent 状态
编辑获取传入的代理数据 (getAgentData)
查询参数
agentsIds(必填)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"items" : [ {
"key" : {
"data" : true
}
}, {
"key" : {
"data" : true
}
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agent_data_200_response400
一般错误 fleet_server_health_check_400_response获取代理状态摘要 (getAgentStatus)
查询参数
policyId(可选)
查询参数 — 默认值:null
kuery(可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"all" : 2,
"offline" : 5,
"other" : 7,
"total" : 9,
"inactive" : 1,
"updating" : 3,
"online" : 2,
"active" : 4,
"error" : 0,
"unenrolled" : 5,
"events" : 6
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agent_status_200_response400
一般错误 fleet_server_health_check_400_response获取代理状态摘要 (getAgentStatusDeprecated)
查询参数
policyId(可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"offline" : 5,
"other" : 2,
"total" : 7,
"inactive" : 1,
"updating" : 9,
"online" : 5,
"error" : 0,
"events" : 6
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agent_status_deprecated_200_response400
一般错误 fleet_server_health_check_400_responseAgents
编辑批量重新分配代理 (bulkReassignAgents)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_reassign_agents_request bulk_reassign_agents_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"actionId" : "actionId"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_upgrade_agents_200_response400
一般错误 fleet_server_health_check_400_response从代理批量请求诊断 (bulkRequestDiagnostics)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_request_diagnostics_request bulk_request_diagnostics_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"actionId" : "actionId"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_upgrade_agents_200_response400
一般错误 fleet_server_health_check_400_response批量取消注册代理 (bulkUnenrollAgents)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_unenroll_agents_request bulk_unenroll_agents_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"actionId" : "actionId"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_upgrade_agents_200_response400
一般错误 fleet_server_health_check_400_response批量更新代理标签 (bulkUpdateAgentTags)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_update_agent_tags_request bulk_update_agent_tags_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"actionId" : "actionId"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_upgrade_agents_200_response400
一般错误 fleet_server_health_check_400_response批量升级代理 (bulkUpgradeAgents)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_upgrade_agents bulk_upgrade_agents(必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"actionId" : "actionId"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_upgrade_agents_200_response400
一般错误 fleet_server_health_check_400_response按 ID 删除代理 (deleteAgent)
路径参数
agentId(必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"action" : "deleted"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 delete_agent_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取代理 (getAgent)
路径参数
agentId(必填)
路径参数 — 默认值:null
查询参数
withMetrics(可选)
查询参数 — 返回代理指标,默认为 false 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agent_200_response400
一般错误 fleet_server_health_check_400_response列出代理标签 (getAgentTags)
返回类型
示例数据
Content-Type: application/json
{
"items" : [ "items", "items" ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agent_tags_response400
一般错误 fleet_server_health_check_400_response获取代理上传的文件 (getAgentUploadFile)
路径参数
fileId(必填)
路径参数 — 默认值:null
fileName(必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"body" : {
"items" : {
"headers" : "",
"body" : ""
}
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agent_upload_file_200_response400
一般错误 fleet_server_health_check_400_response列出代理 (getAgents)
查询参数
perPage(可选)
查询参数 — 要返回的项目数,默认值:20
page(可选)
查询参数 — 默认值:1
kuery(可选)
查询参数 — 默认值:null
showInactive(可选)
查询参数 — 默认值:null
showUpgradeable(可选)
查询参数 — 默认值:null
sortField(可选)
查询参数 — 默认值:null
sortOrder(可选)
查询参数 — 默认值:null
withMetrics(可选)
查询参数 — 返回代理指标,默认为 false 默认值:null
getStatusSummary(可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"total" : 5.962133916683182,
"statusSummary" : {
"offline" : 7.061401241503109,
"inactive" : 2.027123023002322,
"updating" : 1.0246457001441578,
"online" : 3.616076749251911,
"enrolling" : 4.145608029883936,
"unenrolling" : 7.386281948385884,
"degraded'" : 1.4894159098541704,
"error" : 9.301444243932576,
"unenrolled" : 1.2315135367772556
},
"perPage" : 2.3021358869347655,
"page" : 5.637376656633329,
"list" : [ {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}, {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
} ],
"items" : [ {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}, {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agents_response400
一般错误 fleet_server_health_check_400_response按操作 ID 列出代理 (getAgentsByActions)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
get_agents_by_actions_request get_agents_by_actions_request(必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
array[array[String]]
示例数据
Content-Type: application/json
[ [ "", "" ], [ "", "" ] ]
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定400
一般错误 fleet_server_health_check_400_response获取代理设置信息 (getAgentsSetupStatus)
返回类型
示例数据
Content-Type: application/json
{
"missing_requirements" : [ "tls_required", "tls_required" ],
"package_verification_key_id" : "package_verification_key_id",
"isReady" : true,
"missing_optional_features" : [ "encrypted_saved_object_encryption_key_required", "encrypted_saved_object_encryption_key_required" ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 fleet_status_response400
一般错误 fleet_server_health_check_400_response列出代理上传 (listAgentUploads)
路径参数
agentId(必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"body" : {
"item" : [ {
"createTime" : "createTime",
"filePath" : "filePath",
"name" : "name",
"actionId" : "actionId",
"id" : "id",
"status" : "READY"
}, {
"createTime" : "createTime",
"filePath" : "filePath",
"name" : "name",
"actionId" : "actionId",
"id" : "id",
"status" : "READY"
} ]
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 list_agent_uploads_200_response400
一般错误 fleet_server_health_check_400_response重新分配代理 (reassignAgent)
路径参数
agentId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
reassign_agent_deprecated_request reassign_agent_deprecated_request(必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
对象
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 对象400
一般错误 fleet_server_health_check_400_response重新分配代理 (reassignAgentDeprecated)
路径参数
agentId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
reassign_agent_deprecated_request reassign_agent_deprecated_request(必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
对象
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 对象400
一般错误 fleet_server_health_check_400_response请求代理诊断 (requestDiagnosticsAgent)
路径参数
agentId(必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"actionId" : "actionId"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_upgrade_agents_200_response400
一般错误 fleet_server_health_check_400_response启动代理设置 (setupAgents)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
setup_agents_request setup_agents_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"isInitialized" : true,
"nonFatalErrors" : [ {
"name" : "name",
"message" : "message"
}, {
"name" : "name",
"message" : "message"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 fleet_setup_response400
一般错误 fleet_server_health_check_400_response取消注册代理 (unenrollAgent)
路径参数
agentId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
unenroll_agent_request unenroll_agent_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
对象
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 对象400
错误请求 unenroll_agent_400_response按 ID 更新代理 (updateAgent)
路径参数
agentId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
update_agent_request update_agent_request(必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"default_api_key" : "default_api_key",
"enrolled_at" : "enrolled_at",
"access_api_key" : "access_api_key",
"components" : [ {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
}, {
"id" : "id",
"units" : [ {
"payload" : "{}",
"id" : "id",
"message" : "message"
}, {
"payload" : "{}",
"id" : "id",
"message" : "message"
} ],
"type" : "type",
"message" : "message"
} ],
"user_provided_metadata" : "{}",
"unenrollment_started_at" : "unenrollment_started_at",
"policy_id" : "policy_id",
"policy_revision" : 0.8008281904610115,
"active" : true,
"local_metadata" : "{}",
"last_checkin" : "last_checkin",
"access_api_key_id" : "access_api_key_id",
"default_api_key_id" : "default_api_key_id",
"unenrolled_at" : "unenrolled_at",
"id" : "id",
"metrics" : {
"cpu_avg" : 6.027456183070403,
"memory_size_byte_avg" : 1.4658129805029452
}
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_agent_200_response400
一般错误 fleet_server_health_check_400_response升级代理 (upgradeAgent)
路径参数
agentId(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
upgrade_agent upgrade_agent(必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"force" : true,
"version" : "version",
"source_uri" : "source_uri"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 upgrade_agent400
一般错误 fleet_server_health_check_400_response数据流
编辑列出数据流 (dataStreamsList)
返回类型
示例数据
Content-Type: application/json
{
"data_streams" : [ {
"last_activity_ms" : 0.8008281904610115,
"size_in_bytes_formatted" : "size_in_bytes_formatted",
"package" : "package",
"package_version" : "package_version",
"namespace" : "namespace",
"size_in_bytes" : 6.027456183070403,
"index" : "index",
"type" : "type",
"dataset" : "dataset",
"dashboard" : [ {
"id" : "id",
"title" : "title"
}, {
"id" : "id",
"title" : "title"
} ]
}, {
"last_activity_ms" : 0.8008281904610115,
"size_in_bytes_formatted" : "size_in_bytes_formatted",
"package" : "package",
"package_version" : "package_version",
"namespace" : "namespace",
"size_in_bytes" : 6.027456183070403,
"index" : "index",
"type" : "type",
"dataset" : "dataset",
"dashboard" : [ {
"id" : "id",
"title" : "title"
}, {
"id" : "id",
"title" : "title"
} ]
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 data_streams_list_200_response400
一般错误 fleet_server_health_check_400_responseElastic 包管理器 EPM
编辑批量获取资产 (bulkGetAssets)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_get_assets_request bulk_get_assets_request(可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
{
"response" : [ [ {
"attributes" : {
"description" : "description",
"title" : "title"
},
"id" : "id",
"updatedAt" : "updatedAt"
}, {
"attributes" : {
"description" : "description",
"title" : "title"
},
"id" : "id",
"updatedAt" : "updatedAt"
} ], [ {
"attributes" : {
"description" : "description",
"title" : "title"
},
"id" : "id",
"updatedAt" : "updatedAt"
}, {
"attributes" : {
"description" : "description",
"title" : "title"
},
"id" : "id",
"updatedAt" : "updatedAt"
} ] ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_bulk_assets_response400
一般错误 fleet_server_health_check_400_response批量安装软件包 (bulkInstallPackages)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_install_packages_request bulk_install_packages_request(可选)
正文参数 —
查询参数
prerelease(可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、preview)默认值:false
返回类型
示例数据
Content-Type: application/json
{
"response" : [ {
"name" : "name",
"version" : "version"
}, {
"name" : "name",
"version" : "version"
} ],
"items" : [ {
"name" : "name",
"version" : "version"
}, {
"name" : "name",
"version" : "version"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 bulk_install_packages_response400
一般错误 fleet_server_health_check_400_response删除软件包 (deletePackage)
路径参数
pkgName(必填)
路径参数 — 默认值:null
pkgVersion(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
install_package_deprecated_request install_package_deprecated_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
查询参数
ignoreUnverified(可选)
查询参数 — 如果软件包未通过签名验证,则忽略默认值:null
full(可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic Package Registry 支持的字段默认值:null
prerelease(可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、preview)默认值:false
返回类型
示例数据
Content-Type: application/json
{
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 update_package_200_response400
一般错误 fleet_server_health_check_400_response删除软件包 (deletePackageDeprecated)
路径参数
pkgkey(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
install_package_deprecated_request install_package_deprecated_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"response" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 install_package_deprecated_200_response400
一般错误 fleet_server_health_check_400_response获取软件包 (getPackage)
路径参数
pkgName(必填)
路径参数 — 默认值:null
pkgVersion(必填)
路径参数 — 默认值:null
查询参数
ignoreUnverified(可选)
查询参数 — 如果软件包未通过签名验证,则忽略默认值:null
full(可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic Package Registry 支持的字段默认值:null
prerelease(可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、preview)默认值:false
返回类型
示例数据
Content-Type: application/json
null
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_package_200_response400
一般错误 fleet_server_health_check_400_response列出软件包类别 (getPackageCategories)
查询参数
prerelease(可选)
查询参数 — 是否在类别计数中包含预发布软件包(例如 beta、rc、preview)默认值:false
experimental(可选)
查询参数 — 默认值:false
include_policy_templates(可选)
查询参数 — 默认值:false
返回类型
示例数据
Content-Type: application/json
{
"response" : [ {
"count" : 0.8008281904610115,
"id" : "id",
"title" : "title"
}, {
"count" : 0.8008281904610115,
"id" : "id",
"title" : "title"
} ],
"items" : [ {
"count" : 6.027456183070403,
"id" : "id",
"title" : "title"
}, {
"count" : 6.027456183070403,
"id" : "id",
"title" : "title"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_categories_response400
一般错误 fleet_server_health_check_400_response获取软件包 (getPackageDeprecated)
路径参数
pkgkey(必填)
路径参数 — 默认值:null
查询参数
prerelease(可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、preview)默认值:false
返回类型
示例数据
Content-Type: application/json
null
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_package_deprecated_200_response400
一般错误 fleet_server_health_check_400_response获取软件包统计信息 (getPackageStats)
路径参数
pkgName(必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"response" : {
"agent_policy_count" : 0
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_package_stats_200_response400
一般错误 fleet_server_health_check_400_response安装软件包 (installPackage)
路径参数
pkgName(必填)
路径参数 — 默认值:null
pkgVersion(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
install_package_request install_package_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
查询参数
ignoreUnverified(可选)
查询参数 — 如果软件包未通过签名验证,则忽略默认值:null
full(可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic Package Registry 支持的字段默认值:null
prerelease(可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、preview)默认值:false
返回类型
示例数据
Content-Type: application/json
{
"_meta" : {
"install_source" : "registry"
},
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 install_package_200_response400
一般错误 fleet_server_health_check_400_response通过直接上传安装软件包 (installPackageByUpload)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/zip
application/gzip
请求正文
正文 文件(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"_meta" : {
"install_source" : "upload"
},
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 install_package_by_upload_200_response400
一般错误 fleet_server_health_check_400_response安装软件包 (installPackageDeprecated)
路径参数
pkgkey(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
install_package_deprecated_request install_package_deprecated_request(可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"response" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 install_package_deprecated_200_response400
一般错误 fleet_server_health_check_400_response列出软件包 (listAllPackages)
查询参数
excludeInstallStatus(可选)
查询参数 — 是否排除每个软件包的安装状态。启用此选项将选择通过
cache-control
标头缓存响应。如果您不需要软件包的最新安装信息,并且正在查询可用软件包列表,则提供此标志可以大大提高性能。默认值:falseprerelease(可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、preview)默认值:false
experimental(可选)
查询参数 — 默认值:false
category(可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"response" : [ {
"savedObject" : "{}",
"path" : "path",
"download" : "download",
"name" : "name",
"description" : "description",
"installationInfo" : {
"installed_kibana" : {
"id" : "id"
},
"created_at" : "created_at",
"type" : "type",
"verification_status" : "verified",
"installed_es" : {
"deferred" : true,
"id" : "id"
},
"version" : "version",
"experimental_data_stream_features" : "",
"updated_at" : "updated_at",
"install_status" : "installed",
"install_kibana_space_id" : "install_kibana_space_id",
"verification_key_id" : "verification_key_id",
"name" : "name",
"install_source" : "registry",
"install_format_schema_version" : "install_format_schema_version",
"namespaces" : [ "namespaces", "namespaces" ]
},
"icons" : "icons",
"title" : "title",
"type" : "type",
"version" : "version",
"status" : "status"
}, {
"savedObject" : "{}",
"path" : "path",
"download" : "download",
"name" : "name",
"description" : "description",
"installationInfo" : {
"installed_kibana" : {
"id" : "id"
},
"created_at" : "created_at",
"type" : "type",
"verification_status" : "verified",
"installed_es" : {
"deferred" : true,
"id" : "id"
},
"version" : "version",
"experimental_data_stream_features" : "",
"updated_at" : "updated_at",
"install_status" : "installed",
"install_kibana_space_id" : "install_kibana_space_id",
"verification_key_id" : "verification_key_id",
"name" : "name",
"install_source" : "registry",
"install_format_schema_version" : "install_format_schema_version",
"namespaces" : [ "namespaces", "namespaces" ]
},
"icons" : "icons",
"title" : "title",
"type" : "type",
"version" : "version",
"status" : "status"
} ],
"items" : [ {
"savedObject" : "{}",
"path" : "path",
"download" : "download",
"name" : "name",
"description" : "description",
"installationInfo" : {
"installed_kibana" : {
"id" : "id"
},
"created_at" : "created_at",
"type" : "type",
"verification_status" : "verified",
"installed_es" : {
"deferred" : true,
"id" : "id"
},
"version" : "version",
"experimental_data_stream_features" : "",
"updated_at" : "updated_at",
"install_status" : "installed",
"install_kibana_space_id" : "install_kibana_space_id",
"verification_key_id" : "verification_key_id",
"name" : "name",
"install_source" : "registry",
"install_format_schema_version" : "install_format_schema_version",
"namespaces" : [ "namespaces", "namespaces" ]
},
"icons" : "icons",
"title" : "title",
"type" : "type",
"version" : "version",
"status" : "status"
}, {
"savedObject" : "{}",
"path" : "path",
"download" : "download",
"name" : "name",
"description" : "description",
"installationInfo" : {
"installed_kibana" : {
"id" : "id"
},
"created_at" : "created_at",
"type" : "type",
"verification_status" : "verified",
"installed_es" : {
"deferred" : true,
"id" : "id"
},
"version" : "version",
"experimental_data_stream_features" : "",
"updated_at" : "updated_at",
"install_status" : "installed",
"install_kibana_space_id" : "install_kibana_space_id",
"verification_key_id" : "verification_key_id",
"name" : "name",
"install_source" : "registry",
"install_format_schema_version" : "install_format_schema_version",
"namespaces" : [ "namespaces", "namespaces" ]
},
"icons" : "icons",
"title" : "title",
"type" : "type",
"version" : "version",
"status" : "status"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 get_packages_response400
一般错误 fleet_server_health_check_400_response获取受限软件包列表 (listLimitedPackages)
返回类型
示例数据
Content-Type: application/json
{
"items" : [ "items", "items" ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 list_limited_packages_200_response400
一般错误 fleet_server_health_check_400_response获取软件包文件 (packagesGetFile)
路径参数
pkgName(必填)
路径参数 — 默认值:null
pkgVersion(必填)
路径参数 — 默认值:null
filePath (必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"headers" : "{}",
"body" : "{}",
"statusCode" : 0.8008281904610115
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 packages_get_file_200_response400
一般错误 fleet_server_health_check_400_response获取软件包签名验证密钥 ID (packagesGetVerificationKeyId)
返回类型
示例数据
Content-Type: application/json
{
"headers" : "{}",
"body" : {
"id" : "id"
},
"statusCode" : 0.8008281904610115
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 packages_get_verification_key_id_200_response400
一般错误 fleet_server_health_check_400_response更新软件包设置 (updatePackage)
路径参数
pkgName(必填)
路径参数 — 默认值:null
pkgVersion(必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
update_package_request update_package_request (可选)
正文参数 —
查询参数
ignoreUnverified(可选)
查询参数 — 如果软件包未通过签名验证,则忽略默认值:null
full(可选)
查询参数 — 返回软件包清单中的所有字段,而不仅仅是 Elastic Package Registry 支持的字段默认值:null
prerelease(可选)
查询参数 — 是否返回软件包的预发布版本(例如 beta、rc、preview)默认值:false
返回类型
示例数据
Content-Type: application/json
{
"items" : [ {
"id" : "id"
}, {
"id" : "id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 update_package_200_response400
一般错误 fleet_server_health_check_400_response注册 API 密钥
编辑创建注册 API 密钥 (createEnrollmentApiKeys)
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
},
"action" : "created"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 create_enrollment_api_keys_deprecated_200_response400
一般错误 fleet_server_health_check_400_response创建注册 API 密钥 (createEnrollmentApiKeysDeprecated)
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
},
"action" : "created"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 create_enrollment_api_keys_deprecated_200_response400
一般错误 fleet_server_health_check_400_response按 ID 删除注册 API 密钥 (deleteEnrollmentApiKey)
路径参数
keyId (必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"action" : "deleted"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 delete_agent_200_response400
一般错误 fleet_server_health_check_400_response按 ID 删除注册 API 密钥 (deleteEnrollmentApiKeyDeprecated)
路径参数
keyId (必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"action" : "deleted"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 delete_agent_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取注册 API 密钥 (getEnrollmentApiKey)
路径参数
keyId (必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_enrollment_api_key_deprecated_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取注册 API 密钥 (getEnrollmentApiKeyDeprecated)
路径参数
keyId (必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_enrollment_api_key_deprecated_200_response400
一般错误 fleet_server_health_check_400_response列出注册 API 密钥 (getEnrollmentApiKeys)
返回类型
示例数据
Content-Type: application/json
{
"total" : 1.4658129805029452,
"perPage" : 6.027456183070403,
"page" : 0.8008281904610115,
"list" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ],
"items" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_enrollment_api_keys_deprecated_200_response400
一般错误 fleet_server_health_check_400_response列出注册 API 密钥 (getEnrollmentApiKeysDeprecated)
返回类型
示例数据
Content-Type: application/json
{
"total" : 1.4658129805029452,
"perPage" : 6.027456183070403,
"page" : 0.8008281904610115,
"list" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ],
"items" : [ {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
}, {
"policy_id" : "policy_id",
"api_key" : "api_key",
"name" : "name",
"active" : true,
"created_at" : "created_at",
"id" : "id",
"api_key_id" : "api_key_id"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_enrollment_api_keys_deprecated_200_response400
一般错误 fleet_server_health_check_400_responseFleet 内部
编辑Fleet 服务器运行状况检查 (fleetServerHealthCheck)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
fleet_server_health_check_request fleet_server_health_check_request (必填)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"name" : "name",
"host" : "host",
"status" : "status"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 fleet_server_health_check_200_response400
一般错误 fleet_server_health_check_400_response获取设置 (getSettings)
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"has_seen_add_data_notice" : true,
"fleet_server_hosts" : [ "fleet_server_hosts", "fleet_server_hosts" ],
"prerelease_integrations_enabled" : true,
"id" : "id"
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 fleet_settings_response400
一般错误 fleet_server_health_check_400_response启动 Fleet 设置 (setup)
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"isInitialized" : true,
"nonFatalErrors" : [ {
"name" : "name",
"message" : "message"
}, {
"name" : "name",
"message" : "message"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定 fleet_setup_response400
一般错误 fleet_server_health_check_400_response500
内部服务器错误 setup_500_response更新设置 (updateSettings)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
update_settings_request update_settings_request (可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"has_seen_add_data_notice" : true,
"fleet_server_hosts" : [ "fleet_server_hosts", "fleet_server_hosts" ],
"prerelease_integrations_enabled" : true,
"id" : "id"
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 fleet_settings_response400
一般错误 fleet_server_health_check_400_responseFleet 服务器主机
编辑按 ID 删除 Fleet 服务器主机 (deleteFleetServerHosts)
路径参数
itemId (必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"id" : "id"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK delete_package_policy_200_response400
一般错误 fleet_server_health_check_400_response列出 Fleet 服务器主机 (getFleetServerHosts)
返回类型
示例数据
Content-Type: application/json
{
"total" : 0,
"perPage" : 1,
"page" : 6,
"items" : [ {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}, {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_fleet_server_hosts_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取 Fleet 服务器主机 (getOneFleetServerHosts)
路径参数
itemId (必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_one_fleet_server_hosts_200_response400
一般错误 fleet_server_health_check_400_response创建 Fleet 服务器主机 (postFleetServerHosts)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
post_fleet_server_hosts_request post_fleet_server_hosts_request (可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 post_fleet_server_hosts_200_response400
一般错误 fleet_server_health_check_400_response按 ID 更新 Fleet 服务器主机 (updateFleetServerHosts)
路径参数
itemId (必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
update_fleet_server_hosts_request update_fleet_server_hosts_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"host_urls" : [ "host_urls", "host_urls" ],
"is_preconfigured" : true,
"name" : "name",
"id" : "id",
"is_default" : true
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_one_fleet_server_hosts_200_response400
一般错误 fleet_server_health_check_400_responseKubernetes
编辑获取完整的 K8s 代理清单 (getFullK8sManifest)
查询参数
download(可选)
查询参数 — 默认值:null
fleetServer (可选)
查询参数 — 默认值:null
enrolToken (可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : "item"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK agent_policy_download_200_response400
一般错误 fleet_server_health_check_400_response输出
编辑按 ID 删除输出 (deleteOutput)
路径参数
outputId (必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"id" : "id"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK delete_package_policy_200_response400
一般错误 fleet_server_health_check_400_response生成 Logstash API 密钥 (generateLogstashApiKey)
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"api_key" : "api_key"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 generate_logstash_api_key_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取输出 (getOutput)
路径参数
outputId (必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
null
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 output_create_request400
一般错误 fleet_server_health_check_400_response列出输出 (getOutputs)
返回类型
示例数据
Content-Type: application/json
{
"total" : 0,
"perPage" : 1,
"page" : 6,
"items" : [ null, null ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_outputs_200_response400
一般错误 fleet_server_health_check_400_response创建输出 (postOutputs)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
output_create_request output_create_request (必填)
正文参数 —
返回类型
示例数据
Content-Type: application/json
{ }
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 post_outputs_200_response400
一般错误 fleet_server_health_check_400_response按 ID 更新输出 (updateOutput)
路径参数
outputId (必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
output_update_request output_update_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
null
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 output_update_request400
一般错误 fleet_server_health_check_400_response软件包策略
编辑批量获取软件包策略 (bulkGetPackagePolicies)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
bulk_get_package_policies_request bulk_get_package_policies_request (可选)
正文参数 —
查询参数
format (可选)
查询参数 — 软件包输入的简化或旧格式 默认值: null
返回类型
示例数据
Content-Type: application/json
{
"items" : [ null, null ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 bulk_get_package_policies_200_response400
一般错误 fleet_server_health_check_400_response创建软件包策略 (createPackagePolicy)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
package_policy_request package_policy_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
查询参数
format (可选)
查询参数 — 软件包输入的简化或旧格式 默认值: null
返回类型
示例数据
Content-Type: application/json
{ }
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 create_package_policy_200_response400
一般错误 fleet_server_health_check_400_response409
一般错误 fleet_server_health_check_400_response按 ID 删除软件包策略 (deletePackagePolicy)
路径参数
packagePolicyId (必填)
路径参数 — 默认值:null
查询参数
force (可选)
查询参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"id" : "id"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK delete_package_policy_200_response400
一般错误 fleet_server_health_check_400_response列出软件包策略 (getPackagePolicies)
查询参数
perPage(可选)
查询参数 — 要返回的项目数,默认值:20
page(可选)
查询参数 — 默认值:1
kuery(可选)
查询参数 — 默认值:null
format (可选)
查询参数 — 软件包输入的简化或旧格式 默认值: null
返回类型
示例数据
Content-Type: application/json
{
"total" : 0.8008281904610115,
"perPage" : 1.4658129805029452,
"page" : 6.027456183070403,
"items" : [ null, null ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_package_policies_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取软件包策略 (getPackagePolicy)
路径参数
packagePolicyId (必填)
路径参数 — 默认值:null
查询参数
format (可选)
查询参数 — 软件包输入的简化或旧格式 默认值: null
返回类型
示例数据
Content-Type: application/json
{ }
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 create_package_policy_200_response400
一般错误 fleet_server_health_check_400_response删除软件包策略 (postDeletePackagePolicy)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
post_delete_package_policy_request post_delete_package_policy_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
[ {
"success" : true,
"name" : "name",
"id" : "id"
}, {
"success" : true,
"name" : "name",
"id" : "id"
} ]
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定400
一般错误 fleet_server_health_check_400_response按 ID 更新软件包策略 (updatePackagePolicy)
路径参数
packagePolicyId (必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
package_policy_request package_policy_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
查询参数
format (可选)
查询参数 — 软件包输入的简化或旧格式 默认值: null
返回类型
示例数据
Content-Type: application/json
{
"sucess" : true
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 update_package_policy_200_response400
一般错误 fleet_server_health_check_400_response将软件包策略升级到较新的软件包版本 (upgradePackagePolicy)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
upgrade_package_policy_request upgrade_package_policy_request (可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
[ {
"success" : true,
"name" : "name",
"id" : "id"
}, {
"success" : true,
"name" : "name",
"id" : "id"
} ]
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定400
一般错误 fleet_server_health_check_400_response409
一般错误 fleet_server_health_check_400_response软件包策略升级的预演 (upgradePackagePolicyDryRun)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
upgrade_package_policy_dry_run_request upgrade_package_policy_dry_run_request (可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
[ {
"hasErrors" : true,
"agent_diff" : [ [ null, null ], [ null, null ] ],
"diff" : [ null, null ]
}, {
"hasErrors" : true,
"agent_diff" : [ [ null, null ], [ null, null ] ],
"diff" : [ null, null ]
} ]
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
确定400
一般错误 fleet_server_health_check_400_response代理
编辑按 ID 删除代理 (deleteFleetProxies)
路径参数
itemId (必填)
路径参数 — 默认值:null
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"id" : "id"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
OK delete_package_policy_200_response400
一般错误 fleet_server_health_check_400_response列出代理 (getFleetProxies)
返回类型
示例数据
Content-Type: application/json
{
"total" : 0,
"perPage" : 1,
"page" : 6,
"items" : [ {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}, {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
} ]
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_fleet_proxies_200_response400
一般错误 fleet_server_health_check_400_response按 ID 获取代理 (getOneFleetProxies)
路径参数
itemId (必填)
路径参数 — 默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_one_fleet_proxies_200_response400
一般错误 fleet_server_health_check_400_response创建代理 (postFleetProxies)
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
post_fleet_proxies_request post_fleet_proxies_request (可选)
正文参数 —
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 post_fleet_proxies_200_response400
一般错误 fleet_server_health_check_400_response按 ID 更新代理 (updateFleetProxies)
路径参数
itemId (必填)
路径参数 — 默认值:null
使用
此 API 调用通过 Content-Type 请求标头使用以下媒体类型application/json
请求正文
update_fleet_proxies_request update_fleet_proxies_request (可选)
正文参数 —
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"item" : {
"proxy_headers" : "{}",
"certificate_authorities" : "certificate_authorities",
"certificate_key" : "certificate_key",
"name" : "name",
"certificate" : "certificate",
"id" : "id",
"url" : "url"
}
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 get_one_fleet_proxies_200_response400
一般错误 fleet_server_health_check_400_response服务令牌
编辑创建服务令牌 (generateServiceToken)
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"name" : "name",
"value" : "value"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 generate_service_token_deprecated_200_response400
一般错误 fleet_server_health_check_400_response创建服务令牌 (generateServiceTokenDeprecated)
请求标头
kbn-xsrf(必填)
标头参数 — Kibana 的反跨站请求伪造令牌。可以是任何字符串值。默认值:null
返回类型
示例数据
Content-Type: application/json
{
"name" : "name",
"value" : "value"
}
生成
此 API 调用根据 Accept 请求标头生成以下媒体类型;媒体类型将由 Content-Type 响应标头传达。application/json
响应
200
正常 generate_service_token_deprecated_200_response400
一般错误 fleet_server_health_check_400_response模型
[ 跳转到 方法 ]目录
Full_agent_policy_output_permissions
-Full_agent_policy_output_permissions_data
-Full_agent_policy_output_permissions_data_indices_inner
-agent
- 代理agent_action
- 代理操作agent_action_cancel_200_response
-agent_action_oneOf
-agent_action_oneOf_1
-agent_action_oneOf_1_data
-agent_component
- 代理组件agent_component_status
- 代理组件状态agent_component_unit
- 代理组件单元agent_component_unit_type
- 代理组件单元类型agent_diagnostics
- 代理诊断agent_metrics
-agent_policy
- 代理策略agent_policy_agent_features_inner
-agent_policy_copy_request
-agent_policy_create_request
- 创建代理策略请求agent_policy_download_200_response
-agent_policy_full
- 代理策略完整响应agent_policy_full_200_response
-agent_policy_full_200_response_item
-agent_policy_full_oneOf
-agent_policy_info_200_response
-agent_policy_list_200_response
-agent_policy_update_request
- 更新代理策略请求agent_status
- 代理状态agent_type
- 代理类型agents_action_status_200_response
-agents_action_status_200_response_items_inner
-agents_action_status_200_response_items_inner_latestErrors_inner
-bulk_get_agent_policies_200_response
-bulk_get_agent_policies_request
-bulk_get_assets_request
-bulk_get_assets_request_assetIds_inner
-bulk_get_package_policies_200_response
-bulk_get_package_policies_request
-bulk_install_packages_request
-bulk_install_packages_request_packages_inner
-bulk_install_packages_request_packages_inner_oneOf
-bulk_install_packages_response
- 批量安装软件包响应bulk_install_packages_response_response_inner
-bulk_reassign_agents_request
-bulk_reassign_agents_request_agents
-bulk_request_diagnostics_request
-bulk_unenroll_agents_request
-bulk_update_agent_tags_request
-bulk_upgrade_agents
- 批量升级代理bulk_upgrade_agents_200_response
-create_agent_policy_200_response
-create_enrollment_api_keys_deprecated_200_response
-create_package_policy_200_response
-data_stream
- 数据流data_stream_dashboard_inner
-data_streams_list_200_response
-delete_agent_200_response
-delete_agent_policy_200_response
-delete_agent_policy_request
-delete_package_policy_200_response
-download_sources
- 下载源elasticsearch_asset_type
- Elasticsearch 资源类型enrollment_api_key
- 注册 API 密钥fleet_server_health_check_200_response
-fleet_server_health_check_400_response
-fleet_server_health_check_request
-fleet_server_host
- Fleet 服务器主机fleet_settings_response
- Fleet 设置响应fleet_setup_response
- Fleet 设置响应fleet_setup_response_nonFatalErrors_inner
-fleet_status_response
- Fleet 状态响应full_agent_policy
- 完整代理策略full_agent_policy_fleet
-full_agent_policy_fleet_oneOf
-full_agent_policy_fleet_oneOf_1
-full_agent_policy_fleet_oneOf_1_kibana
-full_agent_policy_fleet_oneOf_ssl
-full_agent_policy_input
- 完整 Agent 策略输入full_agent_policy_input_allOf
-full_agent_policy_input_allOf_data_stream
-full_agent_policy_input_allOf_meta
-full_agent_policy_input_allOf_meta_package
-full_agent_policy_input_stream
- 完整 Agent 策略输入流full_agent_policy_input_stream_allOf
-full_agent_policy_input_stream_allOf_data_stream
-full_agent_policy_output
- 完整 Agent 策略full_agent_policy_output_additionalProperties
-full_agent_policy_output_permissions_1_value
-full_agent_policy_secret_references_inner
-generate_logstash_api_key_200_response
-generate_service_token_deprecated_200_response
-get_agent_200_response
-get_agent_data_200_response
-get_agent_data_200_response_items_inner_value
-get_agent_status_200_response
-get_agent_status_deprecated_200_response
-get_agent_tags_response
- 获取 Agent 标签响应get_agent_upload_file_200_response
-get_agent_upload_file_200_response_body
-get_agent_upload_file_200_response_body_items
-get_agents_by_actions_request
-get_agents_response
- 获取 Agent 响应get_agents_response_statusSummary
-get_bulk_assets_response
- 批量获取资产响应get_bulk_assets_response_response_inner_inner
-get_bulk_assets_response_response_inner_inner_attributes
-get_categories_response
- 获取类别响应get_categories_response_items_inner
-get_categories_response_response_inner
-get_download_sources_200_response
-get_enrollment_api_key_deprecated_200_response
-get_enrollment_api_keys_deprecated_200_response
-get_fleet_proxies_200_response
-get_fleet_server_hosts_200_response
-get_one_download_source_200_response
-get_one_fleet_proxies_200_response
-get_one_fleet_server_hosts_200_response
-get_outputs_200_response
-get_package_200_response
-get_package_200_response_allOf
-get_package_200_response_allOf_1
-get_package_deprecated_200_response
-get_package_deprecated_200_response_allOf
-get_package_deprecated_200_response_allOf_1
-get_package_policies_200_response
-get_package_stats_200_response
-get_packages_response
- 获取软件包响应install_package_200_response
-install_package_200_response__meta
-install_package_by_upload_200_response
-install_package_by_upload_200_response__meta
-install_package_by_upload_200_response_items_inner
-install_package_by_upload_200_response_items_inner_type
-install_package_deprecated_200_response
-install_package_deprecated_request
-install_package_request
-installation_info
- 安装信息对象installation_info_installed_es
-installation_info_installed_kibana
-kibana_saved_object_type
- Kibana 已保存对象资产类型list_agent_uploads_200_response
-list_agent_uploads_200_response_body
-list_limited_packages_200_response
-new_agent_action_200_response
-new_agent_action_request
-new_package_policy
- 新软件包策略new_package_policy_inputs_inner
-new_package_policy_package
-output_create_request
- 输出output_create_request_elasticsearch
- Elasticsearchoutput_create_request_elasticsearch_shipper
-output_create_request_elasticsearch_ssl
-output_create_request_kafka
- Kafkaoutput_create_request_kafka_headers_inner
-output_create_request_kafka_random
-output_create_request_kafka_sasl
-output_create_request_kafka_topics_inner
-output_create_request_kafka_topics_inner_when
-output_create_request_logstash
- Logstashoutput_update_request
- 输出output_update_request_elasticsearch
- Elasticsearchoutput_update_request_kafka
- Kafkaoutput_update_request_logstash
- Logstashpackage_info
- 软件包信息package_info_conditions
-package_info_conditions_elasticsearch
-package_info_conditions_kibana
-package_info_data_streams_inner
-package_info_data_streams_inner_vars_inner
-package_info_elasticsearch
-package_info_elasticsearch_privileges
-package_info_screenshots_inner
-package_info_source
-package_policy
- 软件包策略package_policy_allOf
-package_policy_allOf_inputs
-package_policy_request
- 软件包策略请求package_policy_request_inputs_value
-package_policy_request_inputs_value_streams_value
-package_policy_request_package
-package_usage_stats
- 软件包使用统计信息packages_get_file_200_response
-packages_get_verification_key_id_200_response
-packages_get_verification_key_id_200_response_body
-post_delete_package_policy_200_response_inner
-post_delete_package_policy_request
-post_download_sources_200_response
-post_download_sources_request
-post_fleet_proxies_200_response
-post_fleet_proxies_request
-post_fleet_server_hosts_200_response
-post_fleet_server_hosts_request
-post_outputs_200_response
-proxies
- Fleet 代理reassign_agent_deprecated_request
-saved_object_type
- 已保存对象类型search_result
- 搜索结果settings
- 设置setup_500_response
-setup_agents_request
-unenroll_agent_400_response
-unenroll_agent_request
-update_agent_request
-update_download_source_request
-update_fleet_proxies_request
-update_fleet_server_hosts_request
-update_package_200_response
-update_package_policy_200_response
-update_package_request
-update_settings_request
-upgrade_agent
- 升级 Agentupgrade_diff_inner
-upgrade_diff_inner_allOf
-upgrade_diff_inner_allOf_allOf
-upgrade_diff_inner_allOf_allOf_errors_inner
-upgrade_package_policy_dry_run_200_response_inner
-upgrade_package_policy_dry_run_request
-upgrade_package_policy_request
-
agent
- Agent 向上
类型
活动
注册时间
注销时间(可选)
开始注销时间(可选)
访问 API 密钥 ID(可选)
默认 API 密钥 ID(可选)
策略 ID(可选)
策略修订版(可选)
最后签入时间(可选)
用户提供的元数据(可选)
本地元数据(可选)
ID
访问 API 密钥(可选)
状态
默认 API 密钥(可选)
组件(可选)
指标(可选)
agent_policy
- Agent 策略 向上
ID
名称
命名空间
描述(可选)
监控已启用(可选)
枚举
数据输出 ID(可选)
监控输出 ID(可选)
Fleet 服务器主机 ID(可选)
下载源 ID(可选)
注销超时(可选)
不活动超时(可选)
软件包策略(可选)
数组[package_policy] 仅当检索单个 Agent 策略或使用 ?full=true 参数检索 Agent 策略列表时,才会显示此字段
更新时间(可选)
日期 格式:日期时间
更新者(可选)
修订版(可选)
Agent(可选)
Agent 功能(可选)
受保护(可选)
布尔值 指示 Agent 策略是否启用了防篡改功能。默认为 false。
覆盖(可选)
对象 覆盖在 Agent 策略中定义的设置。无法覆盖输入设置。覆盖选项仅应在特殊情况下使用,不应作为例行程序使用。
agents_action_status_200_response_items_inner
- 向上
操作 ID
状态
枚举
完成
已过期
已取消
失败
进行中
ROLLOUT_PASSED
已执行操作的 Agent 数量
大十进制数 已执行操作的 Agent 数量
从 Kibana 创建的操作中包含的 Agent 数量
大十进制数 从 Kibana 创建的操作中包含的 Agent 数量
已确认操作的 Agent 数量
大十进制数 已确认操作的 Agent 数量
执行操作失败的 Agent 数量
大十进制数 执行操作失败的 Agent 数量
版本(可选)
字符串 Agent 版本号(UPGRADE 操作)
开始时间(可选)
字符串 操作的开始时间(计划操作)
类型
枚举
POLICY_REASSIGN
UPGRADE
UNENROLL
强制注销
更新标签
取消
请求诊断
设置
策略更改
输入操作
过期时间(可选)
完成时间(可选)
取消时间(可选)
新策略 ID(可选)
字符串 新策略 ID(POLICY_REASSIGN 操作)
policyId(可选)
字符串 策略 ID(POLICY_CHANGE 操作)
修订版(可选)
字符串 新策略修订版(POLICY_CHANGE 操作)
创建时间
字符串 操作的创建时间
最新错误(可选)
数组[agents_action_status_200_response_items_inner_latestErrors_inner] Agent 执行操作时发生的最新错误
bulk_get_assets_request
- 向上
assetIds
array[bulk_get_assets_request_assetIds_inner] 获取资产所需的项目列表
bulk_unenroll_agents_request
- 向上
bulk_update_agent_tags_request
- 向上
agents
tagsToAdd(可选)
tagsToRemove(可选)
batchSize(可选)
bulk_upgrade_agents
- 批量升级代理 向上
version
String 要升级到的版本
source_uri(可选)
String 备用升级二进制文件下载 URL
rollout_duration_seconds(可选)
Big Decimal 滚动升级窗口持续时间(秒)
start_time(可选)
String 升级开始时间(ISO 8601 格式)
agents
force (可选)
Boolean 强制升级,跳过验证(应谨慎使用)
bulk_upgrade_agents_200_response
- 向上
actionId(可选)
data_streams_list_200_response
- 向上
data_streams(可选)
delete_agent_policy_request
- 向上
agentPolicyId
fleet_server_health_check_request
- 向上
host(可选)
full_agent_policy
- 完整代理策略 向上
ID
outputs
output_permissions(可选)
fleet(可选)
inputs
修订版(可选)
agent(可选)
secret_references(可选)
full_agent_policy_fleet
- 向上
hosts(可选)
proxy_url(可选)
proxy_headers(可选)
ssl(可选)
kibana(可选)
full_agent_policy_fleet_oneOf
- 向上
hosts(可选)
proxy_url(可选)
proxy_headers(可选)
ssl(可选)
full_agent_policy_input
- 完整代理策略输入 向上
ID
名称
revision
类型
data_stream
use_output
meta(可选)
streams(可选)
full_agent_policy_input_allOf
- 向上
ID
名称
revision
类型
data_stream
use_output
meta(可选)
streams(可选)
full_agent_policy_output
- 完整代理策略 向上
hosts
ca_sha256
proxy_url(可选)
proxy_headers(可选)
类型
additionalProperties(可选)
generate_logstash_api_key_200_response
- 向上
api_key(可选)
get_agent_tags_response
- 获取代理标签响应 向上
items(可选)
get_agents_by_actions_request
- 向上
actionIds(可选)
get_agents_response
- 获取代理响应 向上
list(可选)
项目
总数
页码
每页数量
statusSummary(可选)
get_bulk_assets_response_response_inner_inner
- 返回顶部
ID(可选)
类型(可选)
updatedAt (可选)
attributes (可选)
install_package_deprecated_request
- 返回顶部
force (可选)
installation_info
- 安装信息对象 返回顶部
类型(可选)
created_at (可选)
updated_at (可选)
namespaces (可选)
installed_kibana
installed_es
名称
version
install_status
枚举
installed
installing
install_failed
install_source
枚举
registry
upload
bundled
install_kibana_space_id (可选)
install_format_schema_version (可选)
verification_status
枚举
verified
unverified
unknown
verification_key_id (可选)
experimental_data_stream_features (可选)
new_agent_action_request
- 返回顶部
action(可选)
new_package_policy
- 新软件包策略 返回顶部
enabled (可选)
package(可选)
namespace(可选)
output_id (可选)
inputs
策略 ID(可选)
名称
描述(可选)
output_create_request
- 输出 返回顶部
ID(可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
logstash
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl(可选)
proxy_id (可选)
shipper (可选)
版本(可选)
key(可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics
headers(可选)
timeout (可选)
broker_timeout (可选)
broker_buffer_size (可选)
broker_ack_reliability (可选)
output_create_request_elasticsearch
- elasticsearch 返回顶部
ID(可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型(可选)
枚举
elasticsearch
hosts(可选)
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl(可选)
proxy_id (可选)
shipper (可选)
output_create_request_kafka
- kafka 返回顶部
ID(可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
kafka
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl(可选)
proxy_id (可选)
shipper (可选)
版本(可选)
key(可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics
headers(可选)
timeout (可选)
broker_timeout (可选)
broker_buffer_size (可选)
broker_ack_reliability (可选)
output_create_request_kafka_random
- 返回顶部
group_events (可选)
output_create_request_kafka_sasl
- 返回顶部
mechanism (可选)
output_update_request
- 输出 返回顶部
ID(可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
logstash
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl(可选)
proxy_id (可选)
shipper (可选)
版本(可选)
key(可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type (可选)
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics (可选)
headers(可选)
timeout (可选)
broker_timeout (可选)
broker_ack_reliability (可选)
broker_buffer_size (可选)
output_update_request_elasticsearch
- elasticsearch 返回顶部
ID(可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型
枚举
elasticsearch
hosts
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl(可选)
proxy_id (可选)
shipper (可选)
output_update_request_kafka
- kafka 返回顶部
ID(可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型(可选)
枚举
kafka
hosts(可选)
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl(可选)
proxy_id (可选)
shipper (可选)
版本(可选)
key(可选)
compression (可选)
compression_level (可选)
client_id (可选)
auth_type (可选)
username (可选)
password (可选)
sasl (可选)
partition (可选)
random (可选)
round_robin (可选)
topics (可选)
headers(可选)
timeout (可选)
broker_timeout (可选)
broker_ack_reliability (可选)
broker_buffer_size (可选)
output_update_request_logstash
- logstash 返回顶部
ID(可选)
is_default (可选)
is_default_monitoring (可选)
名称
类型(可选)
枚举
logstash
hosts(可选)
ca_sha256 (可选)
ca_trusted_fingerprint (可选)
config (可选)
config_yaml (可选)
ssl(可选)
proxy_id (可选)
shipper (可选)
package_info
- 软件包信息 返回顶部
名称
title
version
release (可选)
String 版本标签已弃用,请从版本派生(软件包遵循语义化版本)
枚举
experimental
beta
ga
source (可选)
readme (可选)
description
类型
categories
conditions
screenshots (可选)
icons (可选)
assets
internal (可选)
format_version
data_streams(可选)
download
path
elasticsearch (可选)
package_info_conditions_kibana
- 返回顶部
versions (可选)
package_info_elasticsearch_privileges
- 返回顶部
cluster(可选)
package_policy
- 软件包策略 返回顶部
ID
revision
inputs
enabled (可选)
package(可选)
namespace(可选)
output_id (可选)
策略 ID(可选)
名称
描述(可选)
package_policy_request
- 软件包策略请求 返回顶部
ID(可选)
String 软件包策略唯一标识符
名称
String 软件包策略名称(应唯一)
描述(可选)
String 软件包策略描述
namespace(可选)
String 默认命名空间为“default”
policy_id
字符串 将添加该软件包策略的代理策略 ID
package
vars (可选)
对象 软件包根级变量(有关更多信息,请参阅集成文档)
inputs (可选)
map[String, package_policy_request_inputs_value] 软件包策略输入(有关可用输入的信息,请参阅集成文档)
force (可选)
布尔值 即使未验证软件包或代理策略已托管,也要强制创建软件包策略。
package_policy_request_inputs_value
- 向上
enabled (可选)
布尔值 启用或禁用该输入(默认为 true)
vars (可选)
对象 输入级别变量(有关更多信息,请参阅集成文档)
streams(可选)
map[String, package_policy_request_inputs_value_streams_value] 输入流(有关可用流的信息,请参阅集成文档)
package_usage_stats
- 软件包使用统计信息 向上
agent_policy_count
packages_get_verification_key_id_200_response_body
- 向上
ID(可选)
字符串 用于验证软件包签名的 GPG 密钥的密钥 ID
reassign_agent_deprecated_request
- 向上
policy_id
setup_500_response
- 向上
消息(可选)
update_package_request
- 向上
keepPoliciesUpToDate (可选)
update_settings_request
- 向上
fleet_server_hosts(可选)
array[String] 每个 URL 的协议和路径必须相同
has_seen_add_data_notice(可选)
additional_yaml_config(可选)
upgrade_diff_inner
- 向上
ID
revision
inputs
enabled (可选)
package(可选)
namespace(可选)
output_id (可选)
策略 ID(可选)
名称
描述(可选)
错误(可选)
missingVars(可选)
upgrade_diff_inner_allOf
- 向上
enabled (可选)
package(可选)
namespace(可选)
output_id (可选)
inputs
策略 ID(可选)
名称
描述(可选)
错误(可选)
missingVars(可选)
upgrade_package_policy_request
- 向上
packagePolicyIds