云客户?
免费开始>
在MyJFrog中升级>
云的新功能>







概述

私有分发网络(PDN)提供了一种方便且最新的自描述API,各种工具/框架可以使用它来自动创建REST调用。

使用

PDN REST API端点可以通过调用RESTful API的任何标准方式调用。本节以cURL为例介绍如何使用PDN REST API。

使用和配置cURL

基URL

平台REST URL由:

//api/< api - version >

在本文档中,您将找到re相关的PDN服务器和PDN节点REST api,以及与PDN相关的开放指标。


生产的api


PDN节点接口

一般下载

描述从PDN按指定路径下载文件
: 1.0.1
安全人工凭证,具有路径上的读权限
使用: GET /artifactory/example-repo-local / example-file.zip范例目录中

旋度Exampl
curl -u admin:password -X GET http://{pdn-node-host}:8089/artifactory/example-repo-local/example-directory/example-file.zip -o ./example-file.zip

响应状态码:
200—文件下载成功
404—与PDN连接的Artifactory上不存在该文件

描述:测试与PDN节点的连接。
: 1.0.1
安全不需要身份验证
使用:/ api / v1 /平

旋度的例子
curl -X GET http://{pdn-node-host}:8089/api/v1/ping

响应状态码
200—待更换的节点可用
5 xx—该节点不可用


PDN服务器api

以下REST api用于PDN服务器。


描述:测试与PDN服务器的连接。
: 1.0.1
安全:不需要认证
使用得到/ api / v1 /系统/平

旋度的例子
$ curl -X GET "http://{pdn-server-host}:8082/pdnserver/api/v1/system/ping"

响应状态码:
200—服务器可用
404年,5 xx
—服务器不可用

活性

描述:测试PDN服务器的活跃度。
: 1.0.1
安全:不需要认证
使用:/ api / v1 /系统/活性

旋度的例子
curl -X GET "http://{pdn-server-host}:8082/pdnserver/api/v1/system/liveness"

响应状态码:
200—服务器是活的
404年,5 xx—服务器未激活

准备

描述:测试PDN服务器的准备情况。
: 1.0.1
安全不需要身份验证
使用:/ api / v1 /系统/准备

旋度的例子
curl -X GET "http://{pdn-server-host}:8082/pdnserver/api/v1/system/readiness"

响应状态码:
200—服务器已准备好接受流量
404年,5 xx—服务器尚未准备好接受流量

清除缓存

描述:清除PDN服务器和PDN节点缓存中的所有文件NodeID GroupId。如果没有提供NodeID和GroupID,将清除所有PDN节点的缓存。
: 1.1.3
安全不需要身份验证
使用: GET /api/v1/file/cache,有2个查询参数group和node


生产指标

生产支持开放的标准这是一个云原生计算基金会的沙盒项目。

访问开放度量的凭据

管理员用户可以使用以下命令创建一个限定范围的访问令牌系统:指标:r并使用该令牌作为获取服务度量的凭据。的一个Dmin可以创建一个只读访问令牌来获取指标,然后允许任何拥有只读令牌的人读取指标。要了解更多信息,请参见访问令牌结构

使能PDN开放指标

要启用PDN服务器的指标,请对以下配置进行更改PDN服务器system.yaml

Pdnserver: metrics: enabled: true间隔:5 exclude:—prefix_1—prefix_2

接下来,要启用PDN节点中的指标,请对PDN节点进行以下配置更改system.yaml

pdnNode: metrics: enabled: true interval: 5 exclude: - prefix_1 - prefix_2 basicAuthUsername:  basicAuthPassword: 

PDN服务器指标

描述:获取PDN服务器的指标。
: 1.0.1
安全:需要有效的作用域的令牌,其中包含“Scope”系统:指标:r”.
使用: GET /api/v1/metrics
授权: N /
内容类型:应用程序/ x-www-form-urlencoded
例子以下是PDN服务器指标的示例;通过访问端点可以获得完整的列表。

# NAME go_memstats_heap_alloc_bytes # TYPE Gauge # HELP处理go堆分配的字节# # NAME app_get_block_duration_secs # TYPE直方图# HELP从Artifactory检索缓存块的时间,单位为秒

PDN节点指标

描述:获取PDN节点的指标。
: 1.0.1
安全:基本授权(凭据从system.yaml).
使用: GET /api/v1/metrics
授权: N /
内容类型:应用程序/ x-www-form-urlencoded
例子以下是PDN节点指标的示例;通过访问端点可以获得完整的列表。

# NAME app_files_serving # TYPE Gauge # HELP下载服务的文件总数# # NAME app_download_speed # TYPE直方图# HELP每个文件的下载速度,单位为MB/s
  • 没有标签
版权所有©2023 JFrog Ltd.