根据ID或路径查询 Codeup 代码库信息

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET /api/v3/projects/info HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
Identity String Query 100

代码库的Id或者路径。

示例:

1. 代码库Id为12345,传参"12345"

2. 代码库的访问地址为https://codeup.aliyun.com/5fb4d216e6f9d07f148526ea/Codeup-Demo,传参"5fb4d216e6f9d07f148526ea/Codeup-Demo";

3. 代码库的克隆地址为git@codeup.aliyun.com:rdc2020/Codeup-Demo.git或者https://codeup.aliyun.com/rdc2020/Codeup-Demo.git,传参rdc2020/Codeup-Demo

使用代码库的 PathWithNamespace 字段作为该接口的参数

OrganizationId String Query 60811b5eed6e867404f6xxxx

企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如

https://devops.aliyun.com/organization/

AccessToken String Query 146dd344827fe2444f952e931e51xxxx

个人访问令牌。

使用阿里云AK+SK或使用STS临时授权方式不需要传该字段

返回数据

名称 类型 示例值 描述
ErrorCode Integer 500

错误码

ErrorMessage String 路径或名称已存在

错误信息

RequestId String xxxx-xxxx-xxxx-xxxx

请求ID

Result Struct

响应结果

AccessLevel Integer 30

权限类型。

20-浏览者

30-开发者

40-管理员

50-企业管理员

Archive Boolean false

归档标识

AvatarUrl String https://xxxxxx

代码库头像地址

CreatedAt String 2020-04-01T11:15:37+08:00

创建时间

CreatorId Long 100

创建者ID

DefaultBranch String master

默认分支

DemoProjectStatus Boolean false

示例库标识

Description String xxxx

描述

HttpUrlToRepo String https://codeup.aliyun.com/xxx/xxx.git

HTTP克隆地址

Id Long 100

代码库ID

ImportFromSubversion Boolean false

是否从SVN导入

ImportStatus String finished

导入状态。none-非导入库,finished-导入成功,failed-导入失败,started-导入中,stopping-停止导入中

ImportUrl String https://codeup.aliyun.com/xxxx/xxxx.git

库导入地址

LastActivityAt String 2020-04-01T11:15:37+08:00

最后活跃时间

Name String xxx

名称

NameWithNamespace String xxx/xxx

名称(含父路径)

Namespace Struct

库所属组或者企业空间信息

Avatar String https://xxxx

头像信息

CreatedAt String 2020-04-01T11:15:37+08:00

创建时间

Description String xxxx

描述

Id Long 100

组ID或企业空间ID

Name String xxx

名称

OwnerId Long 100

归属者ID

Path String xxx

路径

Public Boolean false

是否公开(已废弃,默认为false)

State String active

状态

UpdatedAt String 2020-04-01T11:15:37+08:00

更新时间

VisibilityLevel String 10

可见性。

0:私有,

10:内部公开

Path String xxx

路径

PathWithNamespace String xxx/xxx

路径(含父路径)

Permissions Struct

权限

GroupAccess Struct

组权限

AccessLevel Integer 30

权限类型。

20-浏览者

30-开发者

40-管理员

50-企业管理员

ProjectAccess Struct

库权限

AccessLevel Integer 30

权限类型。

20-浏览者

30-开发者

40-管理员

50-企业管理员

Public Boolean false

是否公开(已废弃,默认为false)

SshUrlToRepo String git@codeup.aliyun.com:xxx/xxx.git

SSH克隆地址

TagList List []

标签列表(已废弃)

VisibilityLevel String 10

可见性。

0:私有,

10:内部公开

WebUrl String https://codeup.aliyun.com/xxx/xxx

页面访问地址

Success Boolean true

请求结果

示例

请求示例

GET /api/v3/projects/info HTTP/1.1
公共请求头
```json
{
    "Identity": "",
    "OrganizationId": ""
}

正常返回示例

XML格式

<RequestId/>
<ErrorCode/>
<ErrorMessage/>
<Success/>
<Result>
    <LastActivityAt/>
    <PathWithNamespace/>
    <Path/>
    <DefaultBranch/>
    <HttpUrlToRepo/>
    <Archive/>
    <Description/>
    <CreatorId/>
    <CreatedAt/>
    <NameWithNamespace/>
    <WebUrl/>
    <VisibilityLevel/>
    <Public/>
    <ImportUrl/>
    <AccessLevel/>
    <Name/>
    <SshUrlToRepo/>
    <DemoProjectStatus/>
    <AvatarUrl/>
    <ImportStatus/>
    <ImportFromSubversion/>
    <Id/>
    <TagList/>
    <Namespace>
        <Path/>
        <Description/>
        <OwnerId/>
        <State/>
        <CreatedAt/>
        <VisibilityLevel/>
        <Public/>
        <Id/>
        <UpdatedAt/>
        <Avatar/>
        <Name/>
    </Namespace>
    <Permissions>
        <ProjectAccess>
            <AccessLevel/>
        </ProjectAccess>
        <GroupAccess>
            <AccessLevel/>
        </GroupAccess>
    </Permissions>
</Result>

JSON格式

{"RequestId":"","ErrorCode":"","ErrorMessage":"","Success":"","Result":{"LastActivityAt":"","PathWithNamespace":"","Path":"","DefaultBranch":"","HttpUrlToRepo":"","Archive":"","Description":"","CreatorId":"","CreatedAt":"","NameWithNamespace":"","WebUrl":"","VisibilityLevel":"","Public":"","ImportUrl":"","AccessLevel":"","Name":"","SshUrlToRepo":"","DemoProjectStatus":"","AvatarUrl":"","ImportStatus":"","ImportFromSubversion":"","Id":"","TagList":"","Namespace":{"Path":"","Description":"","OwnerId":"","State":"","CreatedAt":"","VisibilityLevel":"","Public":"","Id":"","UpdatedAt":"","Avatar":"","Name":""},"Permissions":{"ProjectAccess":{"AccessLevel":""},"GroupAccess":{"AccessLevel":""}}}}

错误码

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