存储库计量API
edit仓库计量API
edit此功能处于技术预览阶段,可能会在未来的版本中进行更改或移除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能支持 SLA 的约束。
您可以使用以下API来检索仓库计量信息。
这是由Elastic的商业产品使用的API。
获取仓库计量信息
edit返回集群仓库的计量信息。
请求
editGET /_nodes/
描述
edit您可以使用集群仓库计量API来检索集群中的仓库计量信息。
此API公开了单调非递减计数器,预计客户端会持久存储计算一段时间内聚合所需的信息。此外,此API公开的信息是易失的,这意味着在节点重启后这些信息将不存在。
响应体
edit-
_nodes -
(对象) 包含关于请求选择的节点数量的统计信息。
Properties of
_nodes-
total - (整数) 请求选择的节点总数。
-
successful - (整数) 成功响应请求的节点数量。
-
failed -
(整数)
拒绝请求或未能响应的节点数量。如果此值不为
0,响应中会包含拒绝或失败的原因。
-
-
cluster_name - (字符串) 集群的名称。基于集群名称设置。
-
nodes -
(对象) 包含请求选择的节点的存储库计量信息。
Properties of
nodes-
-
(数组) 节点仓库计量信息的数组。
Properties of objects in
node_id-
repository_name - (字符串) 仓库名称。
-
repository_type - (字符串) 仓库类型。
-
repository_location -
(对象) 表示仓库中的唯一位置。
Properties of
repository_locationfor repository typeAzure-
base_path - (字符串) 仓库在容器内存储数据的路径。
-
container - (字符串) 容器名称。
Properties of
repository_locationfor repository typeGCP-
base_path - (字符串) 仓库在桶内存储数据的路径。
-
bucket - (字符串) 桶名称。
Properties of
repository_locationfor repository typeS3-
base_path - (字符串) 仓库在桶内存储数据的路径。
-
bucket - (字符串) 桶名称。
-
-
repository_ephemeral_id - (字符串) 每次仓库更新时更改的标识符。
-
repository_started_at - (长整型) 仓库创建或更新的时间。记录为自Unix纪元以来的毫秒数。
-
repository_stopped_at - (可选, 长整型) 仓库删除或更新的时间。记录为自Unix纪元以来的毫秒数。
-
archived - (布尔值) 一个标志,指示此对象是否已被归档。当仓库关闭或更新时,仓库计量信息会被归档并保留一段时间。这允许检索先前仓库实例的计量信息。
-
cluster_version - (可选, 长整型) 此对象被归档时的集群状态版本,此字段可用作逻辑时间戳,以删除所有归档的度量信息,直到观察到的版本。此字段仅存在于归档的仓库计量信息对象中。此字段的主要目的是避免在删除仓库计量信息时可能出现的竞争条件,即删除我们尚未观察到的归档仓库计量信息。
-
request_counts -
(对象) 一个包含针对存储库执行的请求数量的对象,按请求类型分组。
Properties of
request_countsfor repository typeAzureProperties of
request_countsfor repository typeGCP
-
-
清除仓库计量存档
edit移除集群中存在的已归档仓库的计量信息。
请求
editDELETE /_nodes/
描述
edit您可以使用此API来清除集群中归档仓库的计量信息。
路径参数
edit-
<node_id> - (可选,字符串)用于限制返回信息的节点ID或名称的逗号分隔列表。
-
<max_version_to_clear> - (长整型) 指定要从归档中清除的最大 archive_version。
所有节点选择性选项的解释请参见这里。
响应体
edit返回已删除的归档仓库计量信息。
-
_nodes -
(对象) 包含关于请求选择的节点数量的统计信息。
Properties of
_nodes-
total - (整数) 请求选择的节点总数。
-
successful - (整数) 成功响应请求的节点数量。
-
failed -
(整数)
拒绝请求或未能响应的节点数量。如果此值不为
0,响应中会包含拒绝或失败的原因。
-
-
cluster_name - (字符串) 集群的名称。基于集群名称设置。
-
nodes -
(对象) 包含请求选择的节点的存储库计量信息。
Properties of
nodes-
-
(数组) 节点仓库计量信息的数组。
Properties of objects in
node_id-
repository_name - (字符串) 仓库名称。
-
repository_type - (字符串) 仓库类型。
-
repository_location -
(对象) 表示仓库中的唯一位置。
Properties of
repository_locationfor repository typeAzure-
base_path - (字符串) 仓库在容器内存储数据的路径。
-
container - (字符串) 容器名称。
Properties of
repository_locationfor repository typeGCP-
base_path - (字符串) 仓库在桶内存储数据的路径。
-
bucket - (字符串) 桶名称。
Properties of
repository_locationfor repository typeS3-
base_path - (字符串) 仓库在桶内存储数据的路径。
-
bucket - (字符串) 桶名称。
-
-
repository_ephemeral_id - (字符串) 每次仓库更新时更改的标识符。
-
repository_started_at - (长整型) 仓库创建或更新的时间。记录为自Unix纪元以来的毫秒数。
-
repository_stopped_at - (可选, 长整型) 仓库删除或更新的时间。记录为自Unix纪元以来的毫秒数。
-
archived - (布尔值) 一个标志,指示此对象是否已被存档。当仓库关闭或更新时,仓库计量信息会被存档并保留一段时间。这允许检索先前仓库实例的计量信息。
-
cluster_version - (可选, 长整型) 此对象被存档时的集群状态版本,此字段可用作逻辑时间戳,以删除所有观察到的版本之前的存档指标。此字段仅存在于存档的仓库计量信息对象中。此字段的主要目的是避免在删除仓库计量信息时可能出现的竞争条件,即删除我们尚未观察到的存档仓库计量信息。
-
request_counts -
(对象) 一个包含针对存储库执行的请求数量的对象,按请求类型分组。
Properties of
request_countsfor repository typeAzureProperties of
request_countsfor repository typeGCP
-
-