该接口用于查询代码库信息。

调试

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

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
AccessToken String Query 否 146dd344827fe2444f952e931e51xxxx

个人访问令牌。使用阿里云AK+SK或使用STS临时授权方式不需要传该字段
Identity String Query 是 100

代码库的ID或者路径。


1. 代码库ID为12345，传参"12345"
2. 代码库的访问地址为https://codeup.aliyun.com/5fb4d216e6f9d07f148526ea/Codeup-Demo，传参"5fb4d216e6f9d07f148526ea/Codeup-Demo"
OrganizationId String Query 是 60811b5eed6e867404f6xxxx

企业标识，也称企业ID，字符串形式，可在云效访问链接中获取，如https://devops.aliyun.com/organization/【OrganizationId】

返回数据

名称 类型 示例值 描述
ErrorMessage String 路径或名称已存在

错误信息
RequestId String xxxx-xxxx-xxxx-xxxx

请求ID
Success Boolean true

调用是否成功
ErrorCode Integer 500

错误码
Result Object

响应结果
LastActivityAt String 2020-04-01T11:15:37+08:00

最后活跃时间
DefaultBranch String master

默认分支
AvatarUrl String https://xxx

代码库头像地址
Archive Boolean false

归档标识
ImportUrl String https://xxx/xxxx/xxxx

库导入地址
CreatedAt String 2020-04-01T11:15:37+08:00

创建时间
DemoProjectStatus Boolean false

示例库标识
CreatorId Long 100

创建者ID
ImportStatus String finished

导入状态。


none：非导入库
finished：导入成功
failed：导入失败
started：导入中
stopping：停止导入中
HttpUrlToRepo String xxxx

HTTP克隆地址
WebUrl String xxxx

页面访问地址
Description String 描述信息

描述信息
NameWithNamespace String xxx/xxx

名称（含父路径）
Public Boolean false

是否公开（已废弃，默认为false）
PathWithNamespace String xxx/xxx

路径（含父路径）
Path String xxx

路径
VisibilityLevel String 10

可见性。


0：私有
10：内部公开
AccessLevel Integer 30

权限类型。


20：浏览者
30：开发者
40：管理员
50：企业管理员
ImportFromSubversion Boolean false

是否从SVN导入
SshUrlToRepo String xxx

SSH克隆地址
Name String xxx

代码库名称
Id Long 100

代码库ID
TagList Array of String testTag

标签名
Namespace Object

组或企业空间
Avatar String xxx

头像地址
Description String 描述信息

描述
State String active

状态
Public Boolean false

是否公开
VisibilityLevel String 10

可见性。


0：私有
10：内部公开
CreatedAt String 2020-04-01T11:15:37+08:00

创建时间
Path String xxx

组或企业空间路径
UpdatedAt String 2020-04-01T11:15:37+08:00

更新时间
Name String testOrgGroup

名称
OwnerId Long 1000

归属者ID
Id Long 100

组ID或者企业空间ID
Permissions Object

权限
ProjectAccess Object

库权限
AccessLevel Integer 30

权限类型。


20：浏览者
30：开发者
40：管理员
GroupAccess Object

组权限
AccessLevel Integer 30

权限类型。


20：浏览者
30：开发者
40：管理员

示例

请求示例

GET /api/v3/projects/info?AccessToken=146dd344827fe2444f952e931e51xxxx&Identity=100&OrganizationId=60811b5eed6e867404f6xxxx HTTP/1.1
Host:codeup.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetRepositoryInfoResponse>
    <ErrorMessage>路径或名称已存在</ErrorMessage>
    <RequestId>xxxx-xxxx-xxxx-xxxx</RequestId>
    <Success>true</Success>
    <ErrorCode>500</ErrorCode>
    <Result>
        <LastActivityAt>2020-04-01T11:15:37+08:00</LastActivityAt>
        <DefaultBranch>master</DefaultBranch>
        <AvatarUrl>https://xxx</AvatarUrl>
        <Archive>false</Archive>
        <ImportUrl>https://xxx/xxxx/xxxx</ImportUrl>
        <CreatedAt>2020-04-01T11:15:37+08:00</CreatedAt>
        <DemoProjectStatus>false</DemoProjectStatus>
        <CreatorId>100</CreatorId>
        <ImportStatus>finished</ImportStatus>
        <HttpUrlToRepo>xxxx</HttpUrlToRepo>
        <WebUrl>xxxx</WebUrl>
        <Description>描述信息</Description>
        <NameWithNamespace>xxx/xxx</NameWithNamespace>
        <Public>false</Public>
        <PathWithNamespace>xxx/xxx</PathWithNamespace>
        <Path>xxx</Path>
        <VisibilityLevel>10</VisibilityLevel>
        <AccessLevel>30</AccessLevel>
        <ImportFromSubversion>false</ImportFromSubversion>
        <SshUrlToRepo>xxx</SshUrlToRepo>
        <Name>xxx</Name>
        <Id>100</Id>
        <TagList>testTag</TagList>
        <Namespace>
            <Avatar>xxx</Avatar>
            <Description>描述信息</Description>
            <State>active</State>
            <Public>false</Public>
            <VisibilityLevel>10</VisibilityLevel>
            <CreatedAt>2020-04-01T11:15:37+08:00</CreatedAt>
            <Path>xxx</Path>
            <UpdatedAt>2020-04-01T11:15:37+08:00</UpdatedAt>
            <Name>testOrgGroup</Name>
            <OwnerId>1000</OwnerId>
            <Id>100</Id>
        </Namespace>
        <Permissions>
            <ProjectAccess>
                <AccessLevel>30</AccessLevel>
            </ProjectAccess>
            <GroupAccess>
                <AccessLevel>30</AccessLevel>
            </GroupAccess>
        </Permissions>
    </Result>
</GetRepositoryInfoResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ErrorMessage" : "路径或名称已存在",
  "RequestId" : "xxxx-xxxx-xxxx-xxxx",
  "Success" : true,
  "ErrorCode" : 500,
  "Result" : {
    "LastActivityAt" : "2020-04-01T11:15:37+08:00",
    "DefaultBranch" : "master",
    "AvatarUrl" : "https://xxx",
    "Archive" : false,
    "ImportUrl" : "https://xxx/xxxx/xxxx",
    "CreatedAt" : "2020-04-01T11:15:37+08:00",
    "DemoProjectStatus" : false,
    "CreatorId" : 100,
    "ImportStatus" : "finished",
    "HttpUrlToRepo" : "xxxx",
    "WebUrl" : "xxxx",
    "Description" : "描述信息",
    "NameWithNamespace" : "xxx/xxx",
    "Public" : false,
    "PathWithNamespace" : "xxx/xxx",
    "Path" : "xxx",
    "VisibilityLevel" : "10",
    "AccessLevel" : 30,
    "ImportFromSubversion" : false,
    "SshUrlToRepo" : "xxx",
    "Name" : "xxx",
    "Id" : 100,
    "TagList" : [ "testTag" ],
    "Namespace" : {
      "Avatar" : "xxx",
      "Description" : "描述信息",
      "State" : "active",
      "Public" : false,
      "VisibilityLevel" : "10",
      "CreatedAt" : "2020-04-01T11:15:37+08:00",
      "Path" : "xxx",
      "UpdatedAt" : "2020-04-01T11:15:37+08:00",
      "Name" : "testOrgGroup",
      "OwnerId" : 1000,
      "Id" : 100
    },
    "Permissions" : {
      "ProjectAccess" : {
        "AccessLevel" : 30
      },
      "GroupAccess" : {
        "AccessLevel" : 30
      }
    }
  }
}

错误码

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