任务控制REST API

概述

任务控制公开了一个丰富的REST API，允许对注册的JFrog平台部署(jpd)进行完全自动化的管理。

这提供了一个方便且最新的自描述API，各种工具都可以使用它来自动化管理和配置操作。

一个uthentication

任务控制的REST API支持认证类型:

类型

描述

基本

如果未设置身份验证提供程序，请使用您的用户名和密码。或者使用本地管理员执行REST api。

访问令牌

如果设置了认证提供者，则用户必须在授权头中使用访问令牌作为承载令牌。

使用承载令牌进行身份验证的示例:

创建访问令牌．

运行curl -H '授权:承载[令牌]http://localhost:8080/api/v1/services

使用

任务控制REST API可以以REST API的任何标准方式调用。下面以cURL为例介绍如何使用Mission Control REST API。

使用和配置cURL

你可以下载旋度在这里。学习如何使用和配置旋度在这里。

示例—创建站点

下面的示例演示如何调用create用户REST API。

您在本地系统的8080端口上运行了MissionControl
您希望创建一个名为“us-west”的网站Artifactory和x射线。
您创建了一个名为createsite.json

要使用该文件创建一个新用户，您将使用以下命令:

使用cURL和REST API

$ curl 'http://localhost:8080/api/v1/sites' -i -u 'admin:password' -X POST -H 'Content-Type: application/json;charset=UTF-8' -T createsite.json

文件createsite。Json将包含以下内容:

{"name": "US - West "， "description": "US West coast site"， "city": {"name": "Sunnyvale"， "country_code": "US"， "latitude": 37.368830， "longitude": -122.036350}， "services": ["art - West "， "xray-west"]}

页面内容

阅读更多

系统

系统健康检查

描述:获取任务控制是否正在运行的指示。无需身份验证。
自:2．0
用法:GET / api / v1 /平
例子:

GET /api/v1/ping true

代理

创建代理

描述:添加代理。

自:3.2

安全:需要管理员用户

用法:POST / api / v1 /代理

消耗:application / json

例子:

POST /api/v1/ proxy HTTP/1.1 {"name": "proxy-01"， "url": "http://proxyurl:8080"， "sites": [{"source_site": "source-Site"， "destination_site": "destination-Site"}]， "username": "username"， "password": "password"}

例子:

$ curl 'http://localhost:8080/api/v1/proxies' -i -u 'admin:password' -X POST -H 'Content-Type: application/json;charset=UTF-8' -d '{"name": "proxy-01"， "url": "http://proxyurl:8080"， "sites": [{"source_site": "source-Site"， "destination_site": "destination-Site"}]， "username": "username"， "password": "password"}'

创建外部代理

描述:添加外部代理。
自:3.2
安全:需要管理员用户
用法:POST / api / v1 /代理
消耗:application / json

例子:

POST /api/v1/ proxy HTTP/1.1 {"name": "proxy-01"， "url": "http://proxyurl:8080"， "sites": [{"source_site": "source-Site"}]， "username": "username"， "password": "password"}

按名称更新代理

描述:更新代理。
自:3.2
安全:需要管理员用户
用法:POST / api / v1 /代理/{名称}
消耗:application / json

例子:

PUT /api/v1/ agents /proxy-01 HTTP/1.1 {"name": "proxy-01-1"， "url": "http://a53dacff-7d2a-4991-bea0-231abe891e52:8080"， "sites": [{"source_site": "source-Site2"， "destination_site": "destination-Site2"}]， "username": "username1"， "password": "password1"}

获取代理列表

描述:获取代理列表。
自:3.2
安全:需要管理员用户
用法:Get / api / v1 /代理
消耗:application / json

例子:

GET /api/v1/ proxy HTTP/1.1 [{"name": "proxy-01"， "url": "http://ff121cae-f1f1-4639-85ff-cb07c744c730"， "sites": [{"source_site": "source-site-name"， "destination_site": "destination-site-name"}]}， {"name": "proxy-02"， "url": "http://14dc60cb-e3c2-476f-b4a6-263adf70a34d"， "sites": [{"source_site": "source-site-name"}]}]

命令行:

$ curl 'http://localhost:8080/api/v1/proxies' -i -u 'admin:密码' -H '内容类型:应用程序/json;charset = utf - 8 '

获取源JPU过滤的代理列表

描述:根据源JPU获取代理列表。
自:3.2
安全:需要管理员用户
用法:/ api / v1 /代理吗?src_JPU = {JPU_name}
消耗:application / json

例子:

/ api / v1 /代理吗?src_JPU=artifactory HTTP/1.1 [{"name": "proxy-01"， "url": "http://cfc3cf06-18b2-414c-a3e7-12dfd593201d"， "sites": [{"source_site": "source-site-name"， "destination_site": "destination-site-name"}]}]

获取目标JPU过滤的代理列表

描述:获取按目标JPU筛选的代理列表。
自:3.2
安全:需要管理员用户
用法:/ api / v1 /代理吗?dest_JPU = {destination_JPU_name}
消耗:application / json

例子:

/ api / v1 /代理吗?dest_JPU=artifactory HTTP/1.1 [{"name": "proxy-01"， "url": "http://609c68a0-9e8c-4104-adac-0623914c85bf"， "sites": [{"source_site": "source-site-name"， "destination_site": "destination-site-name"}]}]

获取源和目标JPU过滤的代理列表

描述:根据源JPU获取代理列表。

自:3.2

安全:需要管理员用户

用法:/ api / v1 /代理吗?src_JPU = {source_JPU_name} &dest_JPU = {destination_JPU_name}

消耗:application / json

例子:

/ api / v1 /代理吗?src_JPU=source-artifactory&dest_JPU=destination [{"name": "proxy-01"， "url": "http://609c68a0-9e8c-4104-adac-0623914c85bf"， "sites": [{"source_site": "source-site-name"， "destination_site": "destination-site-name"}]}]

按名称获取代理

描述:按名字找一个代理。
自:3.2
安全:需要管理员用户
用法:GET / api / v1 /代理/{名称}
消耗:application / json

例子:

GET /api/v1/ agents /proxy-01 HTTP/1.1 {"name": "proxy-01"， "url": "http://0277a02d-5267-46c9-a5c9-7836f0bff8fb"， "sites": [{"source_site": "source-Site"， "destination_site": "destination-Site"}]}

按名称删除代理

描述:从任务控制中移除代理。
自:3.2
安全:需要管理员用户
用法:删除/ api / v1 /代理/{名称}
消耗:application / json

例子:

删除/api/v1/ proxy /proxy-01 HTTP/1.1

网站

这些是配置站点时的相关字段:

场	类型	可选	描述
名字	字符串	假	网站的名称
描述	字符串	真正的	网站的描述
城市	对象	假	网站的城市
city.name	字符串	真正的	城市的名字
city.country_code	字符串	真正的	城市国家代码
city.longitude	数量	假	城市的经度
city.latitude	数量	假	城市的纬度
JPUs	数组	真正的	喷气推进系统名称

创建网站

描述:创建一个新站点。

自:2．0

安全:需要管理员用户

用法:POST / api / v1 /网站

返回代码:

201 -无内容
400 -无法找到具有以下名称的JPU:， ''，''

409 -名称' <网站名称>已经存在。

消耗:application / json

{"name": "<站点名称>"，"description": "<站点名称>"，"city": {"name": "<城市名称>"，"country_code": "<国家代码>"，"latitude": <城市纬度坐标>，"longitude": <城市高度坐标>}，"JPUs": [""]}

例子:

在本例中，创建了一个新的Sunnyvale站点，jpu“art -west”和“xray-west”与新站点相关联。如果喷气推进小组存在，201年创建将被返回。

$ curl 'http://localhost:8080/api/v1/sites' -i -u 'admin:password' -X POST -H 'Content-Type: application/json;charset=UTF-8' -T createsite.json

createsite.json

{"name": "US - West "， "description": "US West coast site"， "city": {"name": "Sunnyvale"， "country_code": "US"， "latitude": 37.368830， "longitude": -122.036350}， "JPUs": ["art - West "， "x射线- West "]}

更新站点

描述:按名称更新当前站点。

自:从2.0开始
安全:需要admin用户
使用: PUT /api/v1/sites/{name}

返回代码:

204 -无内容
409 -没有找到标识符“”的实体“Site”

消耗:application / json

{"name": "<更新站点名称>"，"description": "<更新站点描述>"，"city": {"name": "<更新城市名称>"，"country_code": "<更新国家代码>"，"latitude": <更新城市纬度坐标>，"longitude": <更新城市纬度坐标>}，"JPUs": [{"name": ""，"type": ""}]}

例子：

在本例中，使用适当的属性将名为Argentina的现有站点更新为Mexico Data Center。如果“阿根廷”这个网站存在，204无内容将被退回

$ curl -XPUT 'http://localhost:8080/api/v1/sites/Argentina' -i -u 'admin:密码' -H '内容类型:应用程序/json;charset=UTF-8' -T updatesite.json

updatesite.json

{"name": "Mexico Data Center"， "description": "Updated site description"， "city": {"name": "Mexico city"， "country_code": "MX"， "latitude": 19.428470， "longitude": -99.127660}}

按名称部分更新站点

描述:更新站点不需要更新属性．
自:2.1

安全:需要管理员用户

用法:把/ api / v1 / JPUs /{名称}

返回代码:

204 -无内容
消耗:application / json

补丁/ api / v1 /网站/{名称}

例子:

PATCH /api/v1/sites/Site%20name HTTP/1.1内容类型:application/json;charset=UTF-8 Host: localhost:8080 Content- length: 119 {"name": "更新的站点名称"，"description": "更新的站点描述"，"JPUs": ["Artifactory name"]} HTTP/1.1 204无内容

例子:

$ curl 'http://localhost:8080/api/v1/sites/Site%20name' -i -u 'admin:password' -X PATCH -H 'Content-Type: application/json;charset=UTF-8' -d '{"name": "更新站点名称"，"description": "更新站点描述"，"JPUs": ["Artifactory name"]}'

让网站

描述:按名称获取站点

自:2．0

安全:需要管理员用户

用法:GET / api / v1 /网站/{名称}

返回代码:

200 -成功
409 -实体“站点”与标识符“{name}”不被发现”

生产:application / json

{"name": "<站点名称>"，"description": "<站点名称>"，"city": {"name": "<城市名称>"，"country_code": "CODE"， "latitude": <城市纬度坐标>，"longitude": <城市高度坐标>}，"JPUs": [{"name": ""，"type": ""}]}

例子:

在本例中，正在检索有关名为“中国”的站点的信息。如果网站“中国”存在200年成功将被退回

$ curl -XGET 'http://localhost:8080/api/v1/sites/China' -uadmin:密码

示例输出

{"name": "Beijing"， "description": "Beijing Data Center"， "city": {"name": "Beijing"， "country_code": "CN"， "latitude": 39.907500， "longitude": 116.397230}， "JPUs": [{"name": "art - Beijing"， "type": "ARTIFACTORY"}]} 200成功

获取网站列表

描述:获取所有站点的列表

自:2．0

安全:需要管理员用户

用法:GET / api / v1 /网站/

返回代码:

200 -成功
409 -没有找到标识符“”的实体“Site”

生产:application / json

[{"name": "<站点名称>"，"description": "<站点名称>"，"city": {"name": "<城市名称>"，"country_code": "CODE"， "latitude": <城市纬度坐标>，"longitude": <城市高度坐标>}，"JPUs": [{"name": ""，"type": ""}]}]

例子:

$ curl -XGET 'http://localhost:8080/api/v1/sites' -uadmin:密码

示例输出

[{"name": "中国"，"description": "" "城市":{"name": "上海"，"country_code": "CN"， "纬度":31.22222，"经度":121.45806}，"JPUs": [{"name": "中国"，"type": "ARTIFACTORY"}]}， {"name": "阿根廷"，"description": "AR"， "纬度":-34.61315，"经度":-58.37723}，"JPUs": [{"name": "Source Local"， "type": "ARTIFACTORY"}]}] 200成功

删除网站

描述:删除站点

自:2．0

安全:需要管理员用户

用法:删除/ api / v1 /网站/{名称}

返回代码:

200 -成功
409 -不能删除站点{name}，它有非空的JPU: {JPU的名称}

例子:

$ curl -XDELETE 'http://localhost:8080/api/v1/sites/China' -uadmin:密码-H "内容类型:应用程序/json"

JPUS

添加JPUs

描述:增加一个新的JPU任务控制。

自:

安全:需要管理员用户

用法:帖子/ api / ui / v1 / jpus

返回代码:

201 -创建
409 -日志含义连接JPU失败。请确认提供的JPU信息是否正确

消耗:application / json

{"name": "jpu-0"， "url": "http://jpu:8080/test"， "token": " sometoken "， "location": {"city_name": "San Francisco"， "country_code": "US"， "latitude": 37.7749， "longitude": 122.4194}， "proxy_key": "proxy1"}

例子:

$ curl 'http://localhost:8080/api/v1/JPUs' -i -u 'admin:password' -X POST -H 'Content-Type: application/json;charset=UTF-8' -T createJPU.json

createservice.json

{"name": "dev-west"， "description": "Artifactory服务西部开发"，"url": "https://artifactory-west.acme.com/artifactory"， "username": "admin"， "password": "password"， "type": "Artifactory "} 201已创建

更新JPU

描述:更新JPU

自:2．0

安全:需要管理员用户

用法:把/ api / v1 / JPUs /{名称}

返回代码:

204 -无内容
409 - Url 已经存在

消耗:application / json

{"name": ""， "description": ""， "url": ""， "username": ""， "password": ""}

例子:

$ curl 'http://localhost:8080/api/ui/v1/jpus/JPU-3' -i -X PUT \

updateservice.json

{" name ": " new_name”、“url”:“http://new-jpu-url: 8080 / jpu。test"， "location": {"city_name": "Toulouse"， "country_code": "FR"， "latitude": 43.6043， "longitude": 1.4437}， "proxy_key": "proxy1"}

获取JPU列表

描述:获取所有jpa的列表

自:2．0

安全:需要管理员用户

用法:GET / api / v1 / JPUs /

生产:application / json

例子:

$ curl -XGET 'http://localhost:8080/api/v1/JPUs' -uadmin:密码

示例输出

[{"name": "阿根廷"，"description": "Artifactory服务于阿根廷发展"，"url": "http://10.0.0.8:8082/artifactory"， "type": "Artifactory "， "JPU_type": "jfrt"， "JPU_id": "jfrt@01ccgfzxdyqd3y0d816fns0zhh"， "site": {"city": {"country_code": "AR"， "latitude": -34.61315， "longitude": -58.37723， "name": "Buenos Aires"}， "description": "" name": "Argentina"}}， {"name": "China"， "description": "Artifactory服务于中国发展"，"url":"http://10.0.0.8:8081/artifactory"， "type": "ARTIFACTORY"， "JPU_type": "jfrt"， "JPU_id": "jfrt@01cdmdjarccxy009wnzmwf06jp"， "site": {"city": {"country_code": "CN"， "latitude": 31.22222， "longitude": 121.45806， "name": "Shanghai"}， "description": "" name": "China"}}] 200成功

根据源获取带有代理的jpu列表

描述:获取任务控制中心使用代理管理的jpu的列表

自:3.2

安全:需要管理员用户

用法:GET请求到/api/v1/JPUs?源=源

消耗:application / json

例子:

GET / api / v1 / JPUs吗?源=源%20Artifactory%20Name HTTP/1.1 [ { "name" : "Source Artifactory Name", "url" : "http://Source Artifactory Name.com/artifactory", "type" : "ARTIFACTORY", "JPU_type" : "jfrt", "JPU_id" : "jfrt@01crqghgxara0b0ej8nct10dyd", "site" : { "name" : "Source Site Name", "description" : "59551ac7-d8a3-426d-90a7-730219f11ddc", "city" : { "name" : "73955951-ef5c-4864-a118-561b117fdb7c", "latitude" : 66.778899, "longitude" : 44.556644 } } }, { "name" : "Destination Artifactory Name", "url" : "http://Destination Artifactory Name.com/artifactory", "type" : "ARTIFACTORY", "JPU_type" : "jfrt", "JPU_id" : "jfrt@01crqghgxf30e91k6gascc1r7p", "site" : { "name" : "Destination Site Name", "description" : "06dce948-ef85-45d6-b600-c2dc8ca57a63", "city" : { "name" : "c64f2329-2021-49ec-9188-cea1840f9df6", "latitude" : 66.778899, "longitude" : 44.556644 } }, "proxy" : { "url" : "http://proxy.com" } } ]

使用基于源的代理通过名称获取JPU

描述:获得JPU的名称管理任务控制与代理。

自:3.2

安全:需要管理员用户

用法:GET / api / v1 / JPUs /{名称}

例子:

GET / api / v1 / JPUs / jfrt % 4001 crqgh6fyxtpn1eyddfwa1hk1 ?源=源%20Artifactory%20Name { "name" : "Destination Artifactory Name", "url" : "http://Destination Artifactory Name.com/artifactory", "type" : "ARTIFACTORY", "JPU_type" : "jfrt", "JPU_id" : "jfrt@01crqgh6fyxtpn1eyddfwa1hk1", "site" : { "name" : "Destination Site Name", "description" : "31c51fe9-dfa0-48d4-8ce7-675e2b6b1b43", "city" : { "name" : "28759984-cf1a-41bc-952c-33e4e3a7c4a0", "latitude" : 66.778899, "longitude" : 44.556644 } }, "proxy" : { "url" : "http://proxy.com" } }

删除JPU

描述:从任务控制中移除一个JPU

自:

安全:需要管理员用户

用法:删除/ api / ui / v1 / jpus / {id}

返回代码:

200 -成功
204 -无内容
404 -未找到

例子:

$ curl 'http://localhost:8080/api/ui/v1/jpus/JPU-321' -i -X DELETE \

获取存储库列表

描述:获取指定Artifactory JPU中的存储库列表

自:2．0

安全:需要管理员用户

用法:得到api / v1 / JPUs / artifactory /{名称}/存储库

返回代码:

200 -成功

无法找到名称的Artifactory实例

消耗:application / json

例子:

$ curl -XGET 'http://localhost:8080/api/v1/JPUs/artifactory/{name}/repositories' -uadmin:密码

示例输出

[{"repository_key": "bower-local"， "description": ""， "type": "local"， "package_type": "bower"}， {"repository_key": "generic-local"， "description": "" type": "package_type": "generic"}， {"repository_key": "lib -release-local"， "description": "" type": "local"， "package_type": "maven"}，…{“repository_key”:“npm”、“描述”:“”,“类型”:“虚拟”,“package_type”:“npm”}]

访问联合会

获取单个JPU的Access Federation配置

描述:获取特定JDPD的访问联合配置。返回为所提供的JPU配置的Federation目标。

自:3．3

安全:需要管理员用户

用法:GET /api/v1/JPU /access/{JPU ID}/federation . GET /api/v1/JPU /access/{JPU ID}/federation . GET /api/v1/JPU /access/

返回代码:

200 -成功
400 - JPU不是一个有效的Access Federation候选。
404 -没有找到JPU或它不是一个Artifactory。
消耗:application / json

请求示例:

GET /api/v1/JPUs/access/JPU-1/federation HTTP/1.1

反应的例子:

{“实体”:“团体”,“用户”,“目标”:[{“名称”:“JFP-2”、“代码”:“access2JPUId”、“url”:“http://localhost: 37837}]}

获取所有jpu的Access Federation配置

描述:获取所有jpa的访问联合配置。

自:3．3

安全:需要管理员用户

用法:GET / api / v1 / JPUs /访问/联盟吗?includeNonConfiguredJPUs = false

返回代码:

200 -成功

生产:application / json

请求示例:

GET / api / v1 / JPUs /访问/联盟吗?include_non_configured HTTP / 1.1 = false

反应的例子:

[{“源”:“artifactory1”,“实体”:“团体”,“用户”,“目标”:[{“名称”:“JPU-2”、“代码”:“access2JPUId”、“url”:“url2”}]}]

在JPU上配置Access Federation

描述:为特定的Artifactory JPU配置访问联合。作为先决条件，必须为基于的Access Federation正确配置了源和目标这．
自:3．3
安全:需要管理员用户
用法:把/ api / v1 / JPUs /访问/ {JPUName} /联邦

返回代码:

200 -成功
400,422 -无效输入
404 - JPU没有找到或没有一个Artifactory

示例请求:

PUT /api/v1/ jpuss /access/artifactory1/federation HTTP/1.1 {"entities": ["USERS"， "GROUPS"]， "targets": [{"name": "artifactory2"， "url": "http://localhost:8080"}]}

示例响应:

[{"label": "获取artifactory1配置"，"status": "OK"}， {"label": "从artifactory1获取访问令牌"，"status": "OK"}， {"label": "检查artifactory2是否信任artifactory1"， "status": "OK"}， {"label": "向artifactory1发送配置"，"status": "OK"}， {"label": "将目标artifactory2添加到artifactory1"， "status": "OK"}]

获取联盟候选人

描述:获取特定JPU的访问联合。
自:3．3
安全:需要管理员用户
用法:GET / api / v1 / JPUs /访问/联盟的候选人

返回代码:
200 -成功

请求示例:

GET /api/v1/ jpuss /access/federation/candidate HTTP/1.1

反应的例子:

["JPU名称1"，"JPU名称2"]

创建网格

描述:创建网格拓扑。作为先决条件，必须为基于的Access Federation正确配置了源和目标这．

自:3．3
安全:需要管理员用户
用法:POST / api / v1 / jpus /访问/联合会/ create_mesh
返回代码:

200 -成功
400,422 -无效输入
404 - JPU没有找到或没有一个Artifactory

请求示例:

POST /api/v1/ jpps /access/federation/create_mesh HTTP/1.1

反应的例子:

{"JPU ": ["JPU名称1"，"JPU名称2"]，"实体":["用户"，"组"，"权限"，"令牌"]}

支持

创建支持包

描述:创建一个新的支持包。
自:3.2
安全:需要管理员用户
笔记:所有的捆绑项目都是可选的。
使用POST /api/v1/system/support/bundle

返回代码:
202 -支持包正在创建中，将很快可用
400 -无效的选项值
403 -未经授权

示例使用：

POST /api/v1/system/support/bundle HTTP/1.1 {"name": "My support bundle"， "description": " support bundle generated because issue XYZ"， "parameters": {"configuration": true， "system": true， "logs": {"include": true， "start_date": "2018-09-19"， "end_date": "2018-09-20"}， "thread_dump": {"count": 1， "interval": 0}}}}}

例子:

$ curl -X POST -uadmin:密码https://my-mission-control.jfrogdev.co/api/v1/system/support/bundle -H 'Content-Type: application/json' \ -d '{"name": "JFMC支持包"，"description": "支持包因XYZ问题而生成"，"parameters": {"configuration": true， "system": true， "thread_dump": {"count": 1， "interval": 0}， "logs": {"include": true， "start_date": "2018-12-25"， "end_date": "2019-01-07"}}}'

示例输出:

HTTP/1.1 202 Accepted Content-Type: application/json x- jfrog - ju - id: jfmc@01c7b8rg70nrqr1cck7k4x0yp7 Server: task -control/SNAPSHOT Strict-Transport-Security: max-age=31536000;inclesubdomains Content-Length: 247 {"id": "SUPP20180912154413548991"， "artifactory": {"JPU_id": "jfrt@4754684682741"， "bundle_url": "http://artifactory.www.si-fil.com/artifactory/jfrog-support-bundle/SUPP20180912154413548991/jfmc/test_JPU}}

获取支持包列表

描述:获取可用支持包的列表。
自:3.2
安全:需要管理员用户
使用GET /api/v1/system/support/bundles

返回代码:
200 -成功
403 -未经授权

例子:

GET /api/v1/system/support/bundles HTTP/1.1

回应:

{“计数”:2,“包”:[{“名称”:“一”,“描述”:“aaa级”、“id”:“1”,“创建”:“2018 - 10 - 01 - t09:50:11z”},{“名称”:“B”、“id”:“2”,“创建”:“2018 - 10 - 01 - t09:50:11z”}]}

获取支持包的详细信息

描述:获取特定支持包的详细信息。
自:3.2
安全:需要管理员用户
使用:/ api / v1 /系统/支持/包/ {id}

返回代码:
200 -成功
403 -未经授权
404 -提供的ID没有引用现有的支持包

例子:

GET /api/v1/system/support/bundle/SUPP20180912154413548991 HTTP/1.1

回应:

{" name ": "问题# 1234”、“描述”:“支持包创建的问题# 1234调查”、“artifactory”:{“JPU_id”:“jfrt@4754684682741”、“bundle_url”:“http://artifactory.www.si-fil.com/artifactory/jfrog-admin-supportbundle/SUPP20180912154413548991/jfmc/01c7b8rg70nrqr1cck7k4x0yp7”},“参数”:{“配置”:真的,“系统”:真的,“日志”:{“包括”:真的,“start_date”:“2018-09-30”,“end_date”:“2018-10-01”},“thread_dump”:{“计数”:1、“间隔”:0}}， "available":5， "created": " 2018-10-01t9: 50:10z "}

下载支持包

描述:以ZIP文件的形式下载支持包。
自:3.2
安全:需要管理员用户。您需要在Artifactory上启用“下载文件夹”权限。
使用:/ api / v1 /系统/支持/包/ {id} /存档

返回代码:
200 -成功
403 -未经授权(可能是“下载文件夹”选项没有在身份验证提供程序Artifactory上启用)
404 -提供的ID没有引用现有的支持包，或者在Authentication Provider Artifactory存储库中找不到ZIP

例子:

GET /api/v1/system/support/bundle/SUPP20180912154413548991/archive HTTP/1.1

删除支持包

描述:删除一个支持包，以及Artifactory中的ZIP文件。
自:3.2
安全:需要管理员用户
使用:删除/ api / v1 /系统/支持/包/ {id}

返回代码:
204 -成功
403 -未经授权
404 -提供的ID没有引用现有的支持包

例子:

DELETE /api/v1/system/support/bundle/SUPP20180912154413548991 HTTP/1.1

创建平台支持包

描述:创建一个新的支持包。为多个jpa创建支持包
自:3．5
安全:需要管理员用户
使用POST /api/v1/platform/support/bundle

返回代码:

200 -支持包正在创建，将很快可用
422 - JPU列表为空或太大
504 -超时
400 -无效请求

示例使用：

POST /api/v1/system/support/bundle HTTP/1.1 {"name": "my_support_bundle"， "description": "平台支持bundle测试描述"，" jpu ": ["self"， "jfrt@64845741457245711"]， "parameters": {"configuration": true， "system": true， "logs": {"include": true， "start_date": "2019-03-14"， "end_date": "2019-03-15"}， "thread_dump": {"count": 1， "interval": 0}}}}

示例输出:

示例输出

200 OK Content-Type: application/json x- jfrog - ju - id: jfrt@4754684682741 Server: task -control/SNAPSHOT Strict-Transport-Security: max-age=31536000;内容长度includeSubDomains: 487 {" id ":“20190315 - 1624 - cab48ff6 - 33 - e4 - 4 - e17 b2c9 - 845 a71ffa3a7”、“地点”:[{“JPU_id”:“jfrt@01d612nxv8yfcn119xsj7d1jrz”、“artifactory”:{“JPU_id”:“jfrt@other.www.si-fil.com”、“bundle_url”:“http://other.www.si-fil.com/artifactory /" } }, { " JPU_id”:“jfmc@01c7b8rg70nrqr1cck7k4x0yp7”、“artifactory”:{“JPU_id”:“jfrt@auth-provider.www.si-fil.com”、“bundle_url”:“http://auth-provider.www.si-fil.com/artifactory /" } } ] }

获取平台支持包列表

描述:获取先前创建的支持包的列表。
自:3．5
安全:需要管理员用户
使用GET /api/v1/platform/support/bundles

返回代码:

200 -好的
400 -无效请求

示例使用：

GET /api/v1/platform/support/bundles HTTP/1.1授权:Basic YWRtaW46cGFzc3dvcmQ= Content-Type: application/json;charset=UTF-8主机:localhost:8080

示例输出:

HTTP/1.1 200 OK Content-Type: application/json x- jfrog - ju - id: jfmc@01c7b8rg70nrqr1cck7k4x0yp7 Server: task -control/SNAPSHOT Strict-Transport-Security: max-age=31536000;includeSubDomains Content-Length: 319 {"bundles": [{"id": "20190218-1554-c5043f76-4d6d-49e2-9ab7-2999b7af02ef"， "name": "sb-name"， "description": "sb-description"， "created": "20190218-1553-bb12b2e0-3b16-44aa-889a-513c14976542"， "created": "2019-02-18T15:53:00Z"}]， "count": 2}

获取平台支持包元数据

描述:获取先前创建的支持包的元数据。
自:3．5
安全:需要管理员用户
使用: GET /api/v1/system/support/bundle/{id}

返回代码:

200 -好的
400 -无效请求

示例使用：

GET /api/v1/platform/support/bundle/20190218-1554-88722539-78af-41bc-a5d7-e7567fb7189f HTTP/1.1授权:Basic YWRtaW46cGFzc3dvcmQ= Content-Type: application/json;charset=UTF-8主机:localhost:8080

示例输出:

HTTP/1.1 200 OK Content-Type: application/json x- jfrog - ju - id: jfmc@01c7b8rg70nrqr1cck7k4x0yp7 Server: task -control/SNAPSHOT Strict-Transport-Security: max-age=31536000;includeSubDomains内容长度:742 {" id ": " 20190218 - 1554 - 20190218 - 78 - af - 41 - bc - a5d7 e7567fb7189f”、“名称”:“sb-name”、“描述”:“sb-description”,“状态”:“成功”,“创建”:“2019 - 02 - 18 t15:54:00z”,“参数”:{“配置”:真的,“系统”:真的,“日志”:{“包括”:真的,“start_date”:“2019-03-14”,“end_date”:“2019-03-15”},“thread_dump”:{“计数”:1、“间隔”:0}},“地点”:[{“JPU_id”:“jfxr@2222”、“artifactory”:{“JPU_id”:“jfrt@jfxr”，“bundle_url”:“https://art。jfxr " } }, { " JPU_id”:“jfds@1111”、“artifactory”:{“JPU_id”:“jfrt@jfds”、“bundle_url”:“https://arti。Jfds "}}]}

获取平台支持包

描述:以ZIP文件的形式下载先前创建的支持包。
自:3．5
安全:需要管理员用户
使用GET /api/v1/platform/support/bundle/{id}/archive

返回代码:

200 -支持包zip将下载
400 -无效请求

示例使用：

GET /api/v1/platform/support/bundle/20190218-1553-2ea5aa8c-0ee7-4981-9028-d19c653b423a/archive HTTP/1.1授权:Basic YWRtaW46cGFzc3dvcmQ= Content-Type: application/json;charset=UTF-8主机:localhost:8080

示例输出:

HTTP/1.1 200 OK内容处理:附件;filename="20190218-1553-2ea5aa8c-0ee7-4981-9028-d19c653b423a.zip" Content-Type: application/zip x- jfrog - ju - id: jfmc@01c7b8rg70nrqr1cck7k4x0yp7 Server: task -control/SNAPSHOT Strict-Transport-Security: max-age=31536000;include esubdomains Content-Length: 28

删除平台支持包

描述:删除之前创建的支持包，以及Artifactory中的ZIP文件。
自:3．5
安全:需要管理员用户
使用: DELETE /api/v1/platform/support/bundle/{id}

返回代码:

支持包成功删除
404 -支持包id未找到或无效
500 -支持无法删除

示例使用：

DELETE /api/v1/platform/support/bundle/20190218-1554-7d3f4afa-a129-435e-822a-d19a052f9b4a HTTP/1.1授权:Basic YWRtaW46cGFzc3dvcmQ= Content-Type: application/json;charset=UTF-8主机:localhost:8080

示例输出:

HTTP/1.1 200 OK Content-Type: application/json x- jfrog - ju - id: jfmc@01c7b8rg70nrqr1cck7k4x0yp7 Server: task -control/SNAPSHOT Strict-Transport-Security: max-age=31536000;inclesubdomains Content-Length: 110 {"deleted": ["jfmc@01c7b8rg70nrqr1cck7k4x0yp7"， "jfrt@01d612qkz4bjqt0e36d13s1ry5"]， "failures": []}

许可证桶

把水桶

描述:检索系统中所有的license桶。

自:3.1.1

安全:需要管理员用户

用法:GET / api / v1 /桶

返回代码:

200 -成功

生产:application / json

[{"id": "<桶id>"， "name": "<桶名>"，"size": <桶>中的license数量，"license_type": ""}]

示例用法:

GET /api/v1/buckets [{"id": "12345"， "name": "bucket-test-1"， "size": 10， "license_type": "ENTERPRISE"}， {"id": "1234567"， "name": "bucket-test-2"， "size": 5， "license_type": "EDGE"}]

创建桶

描述:创建一个新的License Bucket。

自:3.0.0

安全:需要管理员用户

用法:POST / api / v1 /桶

返回代码:

201 -创建
409 -名称“<桶名>”已经存在
409 - Url '<桶Url >'已经存在

消耗:application / json

{"bucket_name": "<桶名>"，"bucket_url": "<桶URL>"， "bucket_key": "<桶密钥>"}

例子:

$ curl 'http://localhost:8080/api/v1/buckets' -i -u 'admin:password' -X POST -H 'Content-Type: application/json;charset=UTF-8' -T createbucket.json

createbucket.json

{"bucket_name": "main-bucket"， "bucket_url": "https://bintray.www.si-fil.com/license-buckets/test_www.si-fil.com/12345678/12345678.json?expiry=1528199600307&id=ABCDEFGhiJkLmNoPQR"， "bucket_key": "16629dbf7fefc9d179b36ba005685c2dd8376aad3278178e735da1633c6bd3c6"}

201已创建{"subject": "JFrog"， "product_name": "Artifactory"， "product_id": 6， "license_type": "HA"， "issued_date": "2018-04-12T16:02:55.549+03:00"， "valid_date": "2019-04-12T16:02:54.759+03:00"， "quantity": 10， "signature": "06307c34405e6ab70c5d249a7ba7cffd81947d5f"， "name": "main-bucket"， "used":0， "url": "https://bintray.www.si-fil.com/license-buckets/test_www.si-fil.com/12345678/12345678.json?expiry=1528199600307&id=ABCDEFGhiJkLmNoPQR"}

上传桶

描述:上传并创建一个新的License Bucket。
自:3.4.2
安全:需要管理员用户
用法:POST / api / v1 /桶
内容类型:多部分/格式

返回代码:

201 -创建
400 -您的bucket文件无法使用。请验证文件是否正确，密钥是否有效。
409 -名称“<桶名>”已经存在

消耗:application / json

bucket_name |任务控制中桶的名称bucket_file |桶文件的路径bucket_key |解密桶的密钥

生产:application / json

{"subject": "JFrog"， "product_name": "Artifactory"， "product_id": 6， "license_type": "HA"， "issued_date": "2016-04-12T16:02:55.549+03:00"， "valid_date": "2017-04-12T16:02:54.759+03:00"， "quantity": 10， "identifier": "bucket-test-1"， "signature": "06307c34405e6ab70c5d249a7ba7cffd81947d5f"， "name": "Test-bucket-name"， "used":0}

例子:

curl 'http://localhost:8080/api/v1/buckets' -i -u 'admin:password' -X POST -H 'Content-Type: multipart/form-data' -F 'bucket_file=@/tmp/728939433.json;type=application/octet-stream' -F 'bucket_key=d18fc5bc05dc3b6419ab6cd127f16cf6b57d7650ea0ef03cde130918f6f25487' -F 'bucket_name=mybucket'

删除桶

描述:删除桶。
自:3.0.0安全性:需要admin用户
用法:删除/ api / v1 /桶/{名称}
返回代码:204 -成功
例子:

$ curl -XDELETE 'http://localhost:8080/api/v1/buckets/main-bucket' -uadmin:password -H "Content- type: application/json" 204无内容

获取桶状态

描述:获取指定桶的报告。
自:2．0
安全:需要管理员用户
用法:GET / api / v1 /桶/{标识符}/报告
生产:application / json

例子:

{"id": "<桶id >"， "size": <桶>中的license数量，"licenses": {"used": <正在使用的license数量>，"available": <正在使用的license数量>，"max_used": <有史以来同时使用的最大license数量>}}

返回代码:

200 -成功

例子:

$ curl -XGET 'http://localhost:8080/api/v1/buckets/415921223/report' -i -u 'admin:password'

示例输出

{"id": "415921223"， "size": 5， "licenses": {"used": 0， "available": 5， "max_used": 0}} 200成功

附加许可

描述:将指定桶中的许可证附加到指定的Artifactory JPU。

自:2．0

安全:需要管理员用户

用法:POST / api / v1 / attach_lic /桶/{名称}

消耗:application / json

{"JPU_name": "Artifactory JPU name"， "deploy": }

生产:application / json

{"license_key": ""}

返回代码:

200 -成功

例子:

$ curl -POST 'http://localhost:8080/api/v1/attach_lic/buckets/{name}' -i -u 'admin:密码' -H '内容类型:应用程序/json;charset=UTF-8' -T attachlicense.json

attachlicense.json

{"JPU_name": "JPUName"， "deploy": false}

示例输出

{"license_key": " "}

5.附加许可证x哈

描述:将指定桶中的多个许可证附加到Artifactory 5。x HA集群。

自:2．0

安全:需要管理员用户

用法:帖子/ api / v1 / attach_lic /桶/{名称}

消耗:application / json

{"number_of_licenses": 5， "JPU_name": ""， "deploy": < false | true >}

返回代码:

200 -成功

409 -“只支持集群部署多个许可证”

例子:

$ curl 'http://localhost:8080/api/v1/attach_lic/buckets/{name}' -i -u 'admin:password' -X POST -H 'Content-Type: application/json;charset=UTF-8' -T attachlicense.json

attachlicense.json

{"number_of_licenses": 5， "JPU_name": "JPUName"， "deploy": false}

内容

空间工具

任务控制REST API

概述

一个uthentication

使用和配置cURL

示例—创建站点

系统

系统健康检查

代理

创建代理

创建外部代理

按名称更新代理

获取代理列表

获取源JPU过滤的代理列表

获取目标JPU过滤的代理列表

获取源和目标JPU过滤的代理列表

按名称获取代理

按名称删除代理

网站

创建网站

更新站点

按名称部分更新站点

让网站

获取网站列表

删除网站

JPUS

添加JPUs

更新JPU

获取JPU列表

根据源获取带有代理的jpu列表

使用基于源的代理通过名称获取JPU

删除JPU

获取存储库列表

访问联合会

获取单个JPU的Access Federation配置

获取所有jpu的Access Federation配置

在JPU上配置Access Federation

获取联盟候选人

创建网格

支持

创建支持包

获取支持包列表

获取支持包的详细信息

下载支持包

删除支持包

创建平台支持包

获取平台支持包列表

获取平台支持包元数据

获取平台支持包

删除平台支持包

许可证桶

把水桶

创建桶

上传桶

删除桶

获取桶状态

附加许可

5.附加许可证x哈