发布链接 API

Tier: 基础版, 专业版, 旗舰版
Offering: JihuLab.com, 私有化部署

History

在极狐GitLab 15.1 中增加了极狐GitLab CI/CD 作业令牌认证。

使用这个 API 来操作极狐GitLab 发布链接。要操作其他发布资产，请参阅发布 API。

极狐GitLab 支持链接到 http、https 和 ftp 资产。

列出发布的链接#

从发布中获取资产作为链接。

plaintext
GET /projects/:id/releases/:tag_name/assets/links

属性	类型	是否必需	描述
id	integer/string	是	项目的 ID 或 URL 编码路径。
tag_name	string	是	与发布相关的标签。

示例请求：

shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links"

示例响应：

json
1[
2   {
3      "id":2,
4      "name":"awesome-v0.2.msi",
5      "url":"http://192.168.10.15:3000/msi",
6      "link_type":"other"
7   },
8   {
9      "id":1,
10      "name":"awesome-v0.2.dmg",
11      "url":"http://192.168.10.15:3000",
12      "link_type":"other"
13   }
14]

获取发布链接#

从发布中获取资产作为链接。

plaintext
GET /projects/:id/releases/:tag_name/assets/links/:link_id

属性	类型	是否必需	描述
id	integer/string	是	项目的 ID 或 URL 编码路径。
tag_name	string	是	与发布相关的标签。
link_id	integer	是	链接的 ID。

示例请求：

shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"

示例响应：

json
1{
2   "id":1,
3   "name":"awesome-v0.2.dmg",
4   "url":"http://192.168.10.15:3000",
5   "link_type":"other"
6}

创建发布链接#

创建一个资产作为发布中的链接。

plaintext
POST /projects/:id/releases/:tag_name/assets/links

属性	类型	是否必需	描述
id	integer/string	是	项目的 ID 或 URL 编码路径。
tag_name	string	是	与发布相关的标签。
name	string	是	链接的名称。链接名称在发布中必须是唯一的。
url	string	是	链接的 URL。链接 URL 在发布中必须是唯一的。
direct_asset_path	string	否	直接资产链接的可选路径。
link_type	string	否	链接类型：other、runbook、image、package。默认值为 other。

示例请求：

shell
1curl --request POST \
2    --header "PRIVATE-TOKEN: <your_access_token>" \
3    --data name="hellodarwin-amd64" \
4    --data url="https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64" \
5    --data direct_asset_path="/bin/hellodarwin-amd64" \
6    "https://gitlab.example.com/api/v4/projects/20/releases/v1.7.0/assets/links"

示例响应：

json
1{
2   "id":2,
3   "name":"hellodarwin-amd64",
4   "url":"https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64",
5   "direct_asset_url":"https://gitlab.example.com/mynamespace/hello/-/releases/v1.7.0/downloads/bin/hellodarwin-amd64",
6   "link_type":"other"
7}

更新发布链接#

更新一个资产作为发布中的链接。

plaintext
PUT /projects/:id/releases/:tag_name/assets/links/:link_id

属性	类型	是否必需	描述
id	integer/string	是	项目的 ID 或 URL 编码路径。
tag_name	string	是	与发布相关的标签。
link_id	integer	是	链接的 ID。
name	string	否	链接的名称。
url	string	否	链接的 URL。
direct_asset_path	string	否	直接资产链接的可选路径。
link_type	string	否	链接类型：other、runbook、image、package。默认值为 other。

您必须至少指定 `name` 或 `url` 之一

示例请求：

shell
curl --request PUT --data name="new name" --data link_type="runbook" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"

示例响应：

json
1{
2   "id":1,
3   "name":"new name",
4   "url":"http://192.168.10.15:3000",
5   "link_type":"runbook"
6}

删除发布链接#

删除一个资产作为发布中的链接。

plaintext
DELETE /projects/:id/releases/:tag_name/assets/links/:link_id

属性	类型	是否必需	描述
id	integer/string	是	项目的 ID 或 URL 编码路径。
tag_name	string	是	与发布相关的标签。
link_id	integer	是	链接的 ID。

示例请求：

shell
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/24/releases/v0.1/assets/links/1"

示例响应：

json
1{
2   "id":1,
3   "name":"new name",
4   "url":"http://192.168.10.15:3000",
5   "link_type":"other"
6}