ListSprints,获取迭代列表-云效(Alibaba Cloud DevOps)-阿里云帮助中心

适用版本

中心版、Region版

服务接入点与授权信息

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

产品	资源	所需权限
项目协作	迭代	只读

请求语法

中心版

GET https://{domain}/oapi/v1/projex/organizations/{organizationId}/projects/{id}/sprints

Region版

GET https://{domain}/oapi/v1/projex/projects/{id}/sprints

请求头

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

请求参数

参数	类型	位置	是否必填	描述	示例值
id	string	path	是	项目唯一标识。	589c53d622cc8521793e08****
status	array[string]	query	否	过滤的状态，TODO,DOING,ARCHIVED，分别对应未开始，进行中，已完成。	TODO,DOING
page	integer	query	否	分页参数，第几页。	1
perPage	integer	query	否	分页参数，每页大小。	20
organizationId	string	path	是：中心版否：Region版	organizationId。

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/organizations/{organizationId}/projects/589c53d622cc8521793e08****/sprints?status=TODO,DOING&name=test&page=1&perPage=20' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/projex/projects/589c53d622cc8521793e08****/sprints?status=TODO,DOING&name=test&page=1&perPage=20' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	array
-	object
capacityHours	integer	迭代工时容量（小时）。	100
creator	object	负责人。
id	string	用户 id。	674d96abd497cd558d68****
name	string	用户名。	user-name-xxx
description	string	描述。	test
endDate	string	结束日期。
gmtCreate	string	创建时间的时间戳。
gmtModified	string	更新时间的时间戳。
id	string	id。	1111
locked	boolean	是否被锁定。	false
modifier	object	负责人。
id	string	用户 id。	674d96abd497cd558d68****
name	string	用户名。	user-name-xxx
name	string	名称。	sprint-test
owners	array	负责人。
-	object	负责人。
id	string	用户 id。	674d96abd497cd558d68****
name	string	用户名。	user-name-xxx
startDate	string	开始日期。
status	string	状态, TODO,DOING,ARCHIVED，分别对应未开始，进行中，已完成。	TODO

返回示例

[
    {
        "capacityHours": 100,
        "creator": {
            "id": "674d96abd497cd558d68****",
            "name": "user-name-xxx"
        },
        "description": "test",
        "endDate": "",
        "gmtCreate": "",
        "gmtModified": "",
        "id": "1111",
        "locked": false,
        "modifier": {
            "id": "674d96abd497cd558d68****",
            "name": "user-name-xxx"
        },
        "name": "sprint-test",
        "owners": [
            {
                "id": "674d96abd497cd558d68****",
                "name": "user-name-xxx"
            }
        ],
        "startDate": "",
        "status": "TODO"
    }
]

响应头

参数	描述	示例值
x-next-page	下一页。
x-page	当前页。
x-per-page	每页数据条数。
x-prev-page	上一页。
x-total	总数据量。
x-total-pages	总分页数。

错误码

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