Harbor-核心管理API

0.概述

核心管理API提供了Harbor核心管理功能的编程接口，这些功能主要如下。
◎ 用户管理(“/users”和“/usergroups”): 覆盖用户和用户组相关的管理功能，包括用户和用户组的创建、修改、查找、删除等。
◎ 项目管理(“/projects”): 覆盖项目相关的管理功能，包括项目的创建、修改、查找、获取概要、删除和项目元信息的管理等。
◎ 仓库管理(“/projects/｛project_name｝/repositories”): 覆盖仓库相关的管理功能，包括仓库的修改、查找和删除等。
◎ Artifact 管理( “/projects/ ｛ project_name ｝ /repositories/｛repository_name｝/artifacts”): 覆盖Artifact相关的管理功能，包括Artifact查找、删除、添加；标签移除；附加属性获取；Tag管理等。
◎ 远程复制（“/replication”和“/registries”）：覆盖远程复制相关的功能，包括仓库服务实例管理及远程复制策略的管理、执行等。
◎ 扫描（“/scanners”“/projects/｛project_id｝/scanner”和“/projects/｛ project_name ｝ /repositories/ ｛ repository_name ｝ /artifacts/｛reference｝/scan”等）：覆盖扫描相关的功能，包括扫描器管理、触发扫描和查看扫描结果等。
◎ 垃圾回收（“/system/gc”）：覆盖垃圾回收相关的功能，包括触发垃圾回收和查看执行结果等。
◎ 项目配额（“/quotas”）：覆盖项目配额相关的功能，包括项目配额的设置、更改和查看等。
◎ Tag保留（“/retentions”）：覆盖Artifact保留策略相关的功能，包括保留策略的创建、修改、删除和执行等。
◎ Artifact管理（“/projects/｛project_id｝/immutabletagrules”）：覆盖项目中不可变Artifact策略相关的功能，包括不可变策略的创建、修改、删除和执行等。
◎ Webhook（“/projects/｛project_id｝/webhook”）：覆盖Webhook相关的功能，包括Webhook的创建、修改和删除等。
◎ 系统配置（“/configurations”和“/systeminfo”）：覆盖系统配置和基本信息相关的功能，包括系统配置的查看和修改等。
核心管理API符合OpenAPI 2.0规范，用户可以参考GitHub上Harbor官方代码仓库中的Swagger文档获取核心管理API的详细信息。查看某个特定版本的API文档时，需要先切换到相应的代码分支，具体位置如表10-1所示。

版本	分支	文档位置
2.0	release-2.0.0	/api/v2.0
1.10	release-1.10.0	/api/harbor
1.9及之前	release-1.9.0等	/docs/swagger.yaml

也可以直接使用API控制中心功能，通过Web页面查看和使用API，具体使用方法请参考10.2.13节。

1.用户管理API

用户管理API（“/users”和“/usergroups”）覆盖用户和用户组相关的管理功能，包括用户和用户组的创建、修改、查找、删除等，如表10-2所示。

https://****:8443/api/v2.0/users

2.项目管理API

2.1 总体的API

2.2 查询当前Harbor所有的projects的情况

1.10.0版本
curl --insecure -u "admin:Harbor12345" -X GET -H "Content-Type: application/json" "https://192.168.244.139/api/projects"2.0版本
curl --insecure -u "admin:Harbor12345" -X GET -H "Content-Type: application/json" https://10.21.37.104:8443/api/v2.0/projects | jq

2.3 创建公开项目

创建一个名称为“test”的公开项目的请求版本1.10.1下测试通过的案例：
curl --insecure -u "admin:Harbor12345" -H "Content-Type: application/json" -d '{"project_name":"test","metedata":{"public":"true"}}' https://192.168.244.139/api/projects版本2.0下测试案例待补充：

2.4 模糊查询项目

模糊查询：
这个查询对于harbor的1.10.0版本是不支持的，
v2.0可以用
curl --insecure -u "admin:Harbor12345" https://10.21.37.104:8443/api/v2.0/projects?q=name=~library

3.仓库管理API

3.1 获取项目library/middleware项目中所有仓库的请求

【v2.0版本】
curl --insecure -u "admin:Harbor12345" https://10.21.37.104:8443/api/v2.0/projects/library/repositories
curl --insecure -u "admin:Harbor12345" https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories

3.2 获取摸个项目的某个参考的信息

获取library/middleware项目中redis仓库的信息
curl --insecure -u "admin:Harbor12345" https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis

4.Artifact管理

curl --insecure -u "admin:Harbor12345" https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/ | jqcurl --insecure -u "admin:Harbor12345" https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/sha256:90f7eba398a51eea8c92718ced52f90433e53573d199fa1f6a6e9aa61ab56875/tags | jq

curl --insecure -u admin:Harbor12345  -H "Content-Type: application/json" -d '{"name":"dev"}' https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/sha256:90f7eba398a51eea8c92718ced52f90433e53573d199fa1f6a6e9aa61ab56875/tags
curl --insecure -u admin:Harbor12345  -H "Content-Type: application/json" -d '{"name":"v3.0.0"}' https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/sha256:90f7eba398a51eea8c92718ced52f90433e53573d199fa1f6a6e9aa61ab56875/tags
./a.out https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/sha256:90f7eba398a51eea8c92718ced52f90433e53573d199fa1f6a6e9aa61ab56875/tags | jq
curl --insecure -u admin:Harbor12345  -H "Content-Type: application/json" -X DELETE https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/sha256:90f7eba398a51eea8c92718ced52f90433e53573d199fa1f6a6e9aa61ab56875/tags/latest
./a.out https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/sha256:90f7eba398a51eea8c92718ced52f90433e53573d199fa1f6a6e9aa61ab56875/tags | jq

通过shell处理直接获取版本号：
curl --insecure -u "admin:Harbor12345" https://10.21.37.104:8443/api/v2.0/projects/middleware/repositories/redis/artifacts/ | sed 's/,/\n/g'  | grep "name" | awk -F ':' '{print $2}' | sed 's/"//g'

12.系统服务API

"auth_mode": {"value": "db_auth"
}, "email_from": {"editable": true,"value": "admin <sample_admin@mydomain.com>"
}, "email_host": {"editable": true,"value": "smtp.mydomain.com"
}, "email_identity": {"editable": true
}, "email_insecure": {"editable": true
}, "email_port": {"editable": true,"value": 25
}, "email_ssl": {"editable": true
}, "email_username": {"editable": true,"value": "sample_admin@mydomain.com"
}, "http_authproxy_admin_groups": {"editable": true
}, "http_authproxy_admin_usernames": {"editable": true
}, "http_authproxy_endpoint": {"editable": true
}, "http_authproxy_server_certificate": {"editable": true
}, "http_authproxy_skip_search": {"editable": true
}, "http_authproxy_tokenreview_endpoint": {"editable": true
}, "http_authproxy_verify_cert": {"editable": true,"value": true
}, "ldap_base_dn": {"editable": true
}, "ldap_filter": {"editable": true
}, "ldap_group_admin_dn": {"editable": true
}, "ldap_group_attribute_name": {"editable": true
}, "ldap_group_base_dn": {"editable": true
}, "ldap_group_membership_attribute": {"editable": true,"value": "memberof"
}, "ldap_group_search_filter": {"editable": true
}, "ldap_group_search_scope": {"editable": true,"value": 2
}, "ldap_scope": {"editable": true,"value": 2
}, "ldap_search_dn": {"editable": true
}, "ldap_timeout": {"editable": true,"value": 5
}, "ldap_uid": {"editable": true,"value": "cn"
}, "ldap_url": {"editable": true
}, "ldap_verify_cert": {"editable": true,"value": true
}, "notification_enable": {"editable": true,"value": true
}, "oidc_admin_group": {"editable": true
}, "oidc_auto_onboard": {"editable": true
}, "oidc_client_id": {"editable": true
}, "oidc_endpoint": {"editable": true
}, "oidc_extra_redirect_parms": {"editable": true,"value": "{}"
}, "oidc_groups_claim": {"editable": true
}, "oidc_name": {"editable": true
}, "oidc_scope": {"editable": true
}, "oidc_user_claim": {"editable": true
}, "oidc_verify_cert": {"editable": true,"value": true
}, "project_creation_restriction": {"editable": true,"value": "everyone"
}, "quota_per_project_enable": {"editable": true,"value": true
}, "read_only": {"editable": true
}, "robot_name_prefix": {"editable": true,"value": "robot$"
}, "robot_token_duration": {"editable": true,"value": 30
}, "scan_all_policy": {}, "self_registration": {"editable": true
}, "storage_per_project": {"editable": true,"value": -1
}, "token_expiration": {"editable": true,"value": 30
}, "uaa_client_id": {"editable": true
}, "uaa_client_secret": {"editable": true
}, "uaa_endpoint": {"editable": true
}, "uaa_verify_cert": {"editable": true
}