ListProjectLabels - 查询类标列表_云效(Apsara Devops)-阿里云帮助中心

查询代码库类标列表，支持分页、字段排序以及关键字搜索。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v4/projects/labels

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https: //devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
accessToken	string	否	个人访问令牌。使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段	f0b1e61db5961df5975a93f9129d2513
repositoryIdentity	string	是	代码库 ID 或者全路径	2835387 或 codeup/codeup-demo
search	string	否	搜索关键字，匹配类标名称	TEST
page	integer	否	页码，默认值为 1，从第 1 页开始	1
pageSize	long	否	每页大小，默认值为 20，取值范围【1,100】	20
orderBy	string	否	排序字段，可选值： label_name：默认，按类标名称排序	label_name
sort	string	否	排序方式，默认为 desc desc：降序 asc：升序	desc
withCounts	boolean	否	是否返回关联的合并请求数量，默认为 false，不返回	false

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID	ASSDS-ASSASX-XSAXSA-XSAXSAXS
success	boolean	调用是否成功	true
errorCode	string	错误码	Openapi.RequestError
errorMessage	string	错误信息	""
total	long	总记录数	30
result	object []	返回结果
id	string	类标 ID，唯一标识	f2bf0e0b4ce34a348b2d971c69a1d11f
name	string	类标名称	优化
color	string	类标颜色	#A16AD7
description	string	类标描述	已有内容的优化或重构
openMergeRequestsCount	long	关联的评审中的合并请求数量	1

示例

正常返回示例

JSON格式

{
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "success": true,
  "errorCode": "Openapi.RequestError",
  "errorMessage": "\"\"",
  "total": 30,
  "result": [
    {
      "id": "f2bf0e0b4ce34a348b2d971c69a1d11f",
      "name": "优化",
      "color": "#A16AD7",
      "description": "已有内容的优化或重构",
      "openMergeRequestsCount": 1
    }
  ]
}

错误码

访问错误中心查看更多错误码。