查询 Codeup 代码库列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /api/v3/projects/all HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
AccessToken | String | Query | 否 | 146dd344827fe2444f952e931e51xxxx | 个人访问令牌。 使用阿里云AK+SK或使用STS临时授权方式不需要传该字段 |
OrganizationId | String | Query | 是 | 60811b5eed6e867404f6xxxx | 企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/ |
Page | Long | Query | 否 | 1 | 页数,最小值为1 |
PageSize | Long | Query | 否 | 20 | 每页条数,范围1, 100 |
Order | String | Query | 否 | created_at | 排序字段。默认值created_at 类型: created_at:创建时间 name:库名称 path:库路径 last_activity_at:最后活跃时间 |
Sort | String | Query | 否 | desc | 排序方式。默认值desc 类型: asc:正序 desc:逆序 |
Search | String | Query | 否 | xx | 搜索关键字 |
Archive | Boolean | Query | 否 | false | 列出归档项目 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | xxxx-xxxx-xxxx-xxxx | 请求ID |
ErrorMessage | String | 代码库不存在 | 错误信息 |
Total | Long | 100 | 代码库总数 |
Success | Boolean | true | 请求结果 |
ErrorCode | Integer | 404 | 错误码 |
Result | Array of Result | 响应数据 |
|
LastActivityAt | String | 2021-06-09T21:02:38+08:00 | 最后活跃时间 |
NamespaceId | Long | 100 | 库所属组或者企业空间 ID |
AvatarUrl | String | https://xxxxxxx | 代码库头像地址 |
StarCount | Long | 0 | 收藏数量 |
Archive | Boolean | false | 归档标识 |
CreatedAt | String | 2021-06-09T21:02:38+08:00 | 创建时间 |
Star | Boolean | false | 是否收藏 |
DemoProjectStatus | Boolean | false | 示例库标识 |
ImportStatus | String | none | 导入状态,类型: 1. failed:失败 2. finished:导入完成 3. none:未开始,非导入库 4. started:导入中 5. stopping:停止导入中 |
WebUrl | String | https://codeup.aliyun.com/xxx/xxx | 页面访问地址 |
Description | String | xxx | 描述 |
NameWithNamespace | String | xxx / xxx | 名称(含父路径) |
PathWithNamespace | String | xxx/xxx | 路径(含父路径) |
Path | String | xxx | 路径 |
VisibilityLevel | String | 10 | 可见性。 类型: 0:私有代码库 10:内部公开库 |
AccessLevel | Integer | 20 | 权限类型。 0
|
UpdatedAt | String | 2021-06-09T21:02:38+08:00 | 更新时间 |
Name | String | xxx | 名称 |
Id | Long | 100 | 代码库ID |
示例
请求示例
GET /api/v3/projects/all HTTP/1.1
公共请求头
```json
{
"OrganizationId": "60811b5eed6e867404f6xxxx"
}
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RequestId>xxxx-xxxx-xxxx-xxxx</RequestId>
<Total>100</Total>
<ErrorCode>404</ErrorCode>
<ErrorMessage>代码库不存在</ErrorMessage>
<Success>true</Success>
<Result>
<LastActivityAt>2021-06-09T21:02:38+08:00</LastActivityAt>
<PathWithNamespace>xxx/xxx</PathWithNamespace>
<Path>xxx</Path>
<Archive>false</Archive>
<Description>xxx</Description>
<CreatedAt>2021-06-09T21:02:38+08:00</CreatedAt>
<NameWithNamespace>xxx / xxx</NameWithNamespace>
<WebUrl>https://codeup.aliyun.com/xxx/xxx</WebUrl>
<VisibilityLevel>10</VisibilityLevel>
<UpdatedAt>2021-06-09T21:02:38+08:00</UpdatedAt>
<AccessLevel>20</AccessLevel>
<Name>xxx</Name>
<DemoProjectStatus>false</DemoProjectStatus>
<AvatarUrl>https://xxxxxxx</AvatarUrl>
<Star>false</Star>
<ImportStatus>none</ImportStatus>
<NamespaceId>100</NamespaceId>
<Id>100</Id>
<StarCount>0</StarCount>
</Result>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "xxxx-xxxx-xxxx-xxxx",
"Total" : "100",
"ErrorCode" : "404",
"ErrorMessage" : "代码库不存在",
"Success" : "true",
"Result" : [ {
"LastActivityAt" : "2021-06-09T21:02:38+08:00",
"PathWithNamespace" : "xxx/xxx",
"Path" : "xxx",
"Archive" : "false",
"Description" : "xxx",
"CreatedAt" : "2021-06-09T21:02:38+08:00",
"NameWithNamespace" : "xxx / xxx",
"WebUrl" : "https://codeup.aliyun.com/xxx/xxx",
"VisibilityLevel" : "10",
"UpdatedAt" : "2021-06-09T21:02:38+08:00",
"AccessLevel" : "20",
"Name" : "xxx",
"DemoProjectStatus" : "false",
"AvatarUrl" : "https://xxxxxxx",
"Star" : "false",
"ImportStatus" : "none",
"NamespaceId" : "100",
"Id" : "100",
"StarCount" : "0"
} ]
}
错误码
访问错误中心查看更多错误码。