ListTags - 查询标签列表-云效(Alibaba Cloud DevOps)-阿里云帮助中心

通过 OpenAPI 查询代码库标签（Tag）列表，支持分页。

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
代码管理	标签	只读

请求语法

中心版

GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/tags

Region版

GET https://{domain}/oapi/v1/codeup/repositories/{repositoryId}/tags

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是：中心版否：Region版	组织 ID。	60d54f3daccf2bbd6659f3ad
repositoryId	string	path	是	代码库 ID 或者 URL-Encoder 编码的全路径。	2813489或者60de7a6852743a5162b5f957%2FDemoRepo
page	integer	query	否	页码，默认从1开始，一般不要超过150页。	1
perPage	integer	query	否	每页大小，默认20，取值范围【1，100】。	20
search	string	query	否	搜索关键字。	Test Tag
sort	string	query	否	排序方式：desc-降序，asc-升序，默认 desc。	desc
orderBy	string	query	否	排序字段：name-按名称排序，create-按创建时间排序，默认为 create。	create

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/codeup/organizations/60d54f3daccf2bbd6659f3ad/repositories/2813489或者60de7a6852743a5162b5f957%2FDemoRepo/tags?page=1&perPage=20&search=Test Tag&sort=desc&orderBy=create' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/codeup/repositories/2813489或者60de7a6852743a5162b5f957%2FDemoRepo/tags?page=1&perPage=20&search=Test Tag&sort=desc&orderBy=create' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
commit	object	提交信息。
authorEmail	string	作者邮箱。	username@example.com
authorName	string	作者姓名。	codeup-name
authoredDate	string	作者提交时间。	2024-10-05T15:30:45Z
committedDate	string	提交者提交时间。	2024-10-05T15:30:45Z
committerEmail	string	提交者邮箱。	username@example.com
committerName	string	提交者姓名。	codeup-name
id	string	提交 ID。	de02b625ba8488f92eb204bcb3773a40c1b4ddac
message	string	提交内容。	Commit Message
parentIds	array[string]	父提交 ID。	["3fdaf119cf76539c1a47de0074ac02927ef4c8e1"]
shortId	string	代码组路径。	de02b625
stats	object	变更行数信息。
additions	integer	增加行数。	1
deletions	integer	删除行数。	1
total	integer	总变动行数。	2
title	string	标题，提交的第一行内容。	Commit Title
webUrl	string	页面访问地址。	http://exmaple.com/example_repo/commit/commit_sha
id	string	主键 ID。	de02b625ba8488f92eb204bcb3773a40c1b4ddac
message	string	标签描述信息。	描述内容
name	string	标签名。	v1.0
release	object	发行版本信息。
description	string	描述信息。	描述内容
tagName	string	标签名。	v1.0

返回示例

[
    {
        "commit": {
            "authorEmail": "username@example.com",
            "authorName": "codeup-name",
            "authoredDate": "2024-10-05T15:30:45Z",
            "committedDate": "2024-10-05T15:30:45Z",
            "committerEmail": "username@example.com",
            "committerName": "codeup-name",
            "id": "de02b625ba8488f92eb204bcb3773a40c1b4ddac",
            "message": "Commit Message",
            "parentIds": ["3fdaf119cf76539c1a47de0074ac02927ef4c8e1"],
            "shortId": "de02b625",
            "stats": {
                "additions": 1,
                "deletions": 1,
                "total": 2
            },
            "title": "Commit Title",
            "webUrl": "http://exmaple.com/example_repo/commit/commit_sha"
        },
        "id": "de02b625ba8488f92eb204bcb3773a40c1b4ddac",
        "message": "描述内容",
        "name": "v1.0",
        "release": {
            "description": "描述内容",
            "tagName": "v1.0"
        }
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。	3
x-page	当前页。	2
x-per-page	每页大小。	20
x-prev-page	前一页。	1
x-request-id	请求 ID。	37294673-00CA-5B8B-914F-A8B35511E90A
x-total	总数。	50
x-total-pages	总分页数。	3

错误码

访问错误码中心查看 API 相关错误码。