查询代码库分支列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /repository/{repositoryId}/branches
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
organizationId | string | 是 | 企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 | 60de7a6852743a5162b5f957 |
accessToken | string | 否 | 个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段 | f0b1e61db5961df5975a93f9129d2513 |
repositoryId | long | 是 | 代码库 ID | 2709413 |
page | long | 否 | 页码,默认值为 1,从第 1 页开始。 | 1 |
pageSize | long | 否 | 每页大小,默认值为 20,取值范围【1,100】 | 20 |
search | string | 否 | 搜索关键字 | Demo |
sort | string | 否 | 排序方式,默认为 updated_desc
| updated_desc |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "1F4F342D-493A-5B2C-B133-BA78B30FF834",
"errorMessage": "\"\"",
"errorCode": "Openapi.RequestError",
"success": true,
"total": 100,
"result": [
{
"name": "testBranch",
"protected": "false",
"commit": {
"id": "de02b625ba8488f92eb204bcb3773a40c1b4ddac",
"shortId": "e0297d8f",
"title": "提交标题",
"authorName": "test-codeup",
"authorEmail": "username@example.com",
"createdAt": "2022-03-18 10:00:00",
"message": "具体的提交内容",
"authoredDate": "2022-03-18 10:00:00",
"committedDate": "2022-03-18 11:00:00",
"committerEmail": "username@example.com",
"committerName": "commit-codeup",
"parentIds": [
"de02b625ba8488f92eb204bcb3773a40c1b4ddac"
]
}
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden.AccessDenied | The user is not authorized to perform the operation. | 用户无权限执行相关操作 |
403 | Forbidden.UserNotInCurrentOrganization | The user is not in the organization and is not authorized to perform the operation. | 当前用户不在该企业中,无权进行操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-11-21 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |