调用ListSprints获取迭代列表_云效(Apsara Devops)-阿里云帮助中心

获取迭代列表。

调试

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

授权信息

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

请求语法

GET /organization/{organizationId}/sprints/list

请求参数

名称	类型	必填	描述	示例值
organizationId	string	是	企业标识，也称企业 id，字符串形式，可在云效访问链接中获取，如 https://devops.aliyun.com/organization/【OrganizationId】	5ebbc0228123212b59xxxxx
spaceIdentifier	string	是	项目唯一标识，同 projectId	e8bxxxxxxxxxxxxxxxx23
spaceType	string	是	类型，这里就写 Project	Project
nextToken	string	否	第一页值不需要填写，后面每一页的值需要从前一次调用结果中获取到此字段，然后获取后面的分页数据	""
maxResults	long	否	每页最大返回数量，0-200，默认值 20	20

返回参数

名称	类型	描述	示例值
	object
totalCount	long	总数	10
nextToken	string	分页 Token，没有下一页则为空	""
maxResults	long	每页数量	20
requestId	string	请求 id，每次请求都是唯一值，便于后续排查问题	ASSDS-ASSASX-XSAXSA-XSAXSAXS
errorMsg	string	错误信息	error
errorCode	string	错误码	Openapi.RequestError
success	boolean	true 或者 false	true
sprints	object []	迭代信息
creator	string	创建人 aliyunPk	19xx7043xxxxxxx914
description	string	描述信息	xxx
gmtCreate	long	创建时间	1623916393000
gmtModified	long	修改时间	1623916393000
endDate	long	结束时间	1623916393000
startDate	long	开始时间	1638403200000
identifier	string	迭代唯一标识符	e8bxxxxxxxxxxxxxxxx23
modifier	string	修改人 aliyunPk	19xx7043xxxxxxx914
name	string	迭代名称	demo示例项目
spaceIdentifier	string	项目唯一标识	5e70xxxxxxcd000xxxxe96
scope	string	可见范围	public
status	string	状态，TODO，DOING，DONE，分别代表迭代未开始，进行中和已完成	TODO

示例

正常返回示例

JSON格式

{
  "totalCount": 10,
  "nextToken": "\"\"",
  "maxResults": 20,
  "requestId": "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
  "errorMsg": "error",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "sprints": [
    {
      "creator": "19xx7043xxxxxxx914",
      "description": "xxx",
      "gmtCreate": 1623916393000,
      "gmtModified": 1623916393000,
      "endDate": 1623916393000,
      "startDate": 1638403200000,
      "identifier": "e8bxxxxxxxxxxxxxxxx23",
      "modifier": "19xx7043xxxxxxx914",
      "name": "demo示例项目",
      "spaceIdentifier": "5e70xxxxxxcd000xxxxe96",
      "scope": "public",
      "status": "TODO"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Openapi.RequestError	request error	OpenAPI请求数据错误
403	Operate.NoPermission	NoPermission	没有权限

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