Help Center/ CodeArts Repo/ API Reference (Ally Region)/ APIs/ Repository/ Querying Details About a Repository
Updated on 2026-01-08 GMT+08:00

Querying Details About a Repository

Description

This API is used to obtain details about a repository by UUID (returned by the CreateRepository API). The returned information contains the ID, name, repo group name, and repository access URL.

URI

GET /v2/repositories/{repository_uuid}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_uuid

Yes

String

Repository UUID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Response error

result

RepoInfoV2 object

Response result

status

String

Response status

Table 4 Error

Parameter

Type

Description

code

String

Error codes

message

String

Error message

Table 5 RepoInfoV2

Parameter

Type

Description

created_at

String

Creation time

creator_name

String

Username of the creator. If the user is a tenant, the username is the same as the tenant name.

domain_name

String

Tenant name of the creator

group_name

String

Repository group name (Segment following the domain name and before the repository name in the clone address. Example: git@repo.alpha.devcloud.intest.com:Demo00228/testword.git. Repository group name: Demo00228.)

https_url

String

URL for cloning repositories using HTTPS

iam_user_uuid

String

IAM user UUID

is_owner

Integer

Whether the current user is the repository creator. 1: Yes. 0: No

lfs_size

String

Repository LFS capacity in MB. If the capacity is greater than 1,024 MB, the unit is GB.

project_is_deleted

String

Whether the project is deleted

project_uuid

String

Project ID. For details, see Obtaining a Project ID.

repository_id

Integer

Repository primary key ID

repository_name

String

Repository name

repository_size

String

Total repository capacity = Repository LFS capacity + Git repository capacity. The unit is MB. If the capacity is greater than 1,024 MB, the unit is GB.

repository_uuid

String

Repository UUID returned by the CreateRepository API.

ssh_url

String

URL for cloning repositories using SSH

star

Boolean

Whether you have followed the repository

status

Integer

Repository status. 0: Created. 1: Creating. 2: Failed. 3: Frozen. 4: Closed.

updated_at

String

Update time

userRole

Integer

Your permission in the repository. 20: Read-only member. 30: Common member. 40: Administrator.

visibility_level

Integer

Visibility. 0: Private. 20: Public

web_url

String

Web URL. If you access it, the repository details page is displayed.

Request Examples

GET https://{endpoint}/v2/repositories/{repository_uuid}

Response Examples

Status code: 200

Request succeeded

{
  "result" : {
    "repository_uuid" : "045ceabb9aea40579d5a759e84fa7f0a",
    "repository_id" : 468485,
    "repository_name" : "CreatRepository_MI9Af",
    "ssh_url" : "git@repo.alpha.devcloud.intest.com:Demo00228/CreatRepository_MI9Af.git",
    "https_url" : "https://repo.alpha.devcloud.intest.com/Demo00228/CreatRepository_MI9Af.git",
    "group_name" : "Demo00228",
    "web_url" : "https://alpha.devcloud.intest.com/repo/468485/home",
    "visibility_level" : 0,
    "created_at" : "2019-10-15 09:40:27",
    "updated_at" : null,
    "repository_size" : null,
    "lfs_size" : null,
    "creator_name" : null,
    "domain_name" : null,
    "star" : null,
    "status" : null,
    "is_owner" : null,
    "iam_user_uuid" : null,
    "project_uuid" : "4838955a48e2492bbe44b31bc4c272f6",
    "project_is_deleted" : "false",
    "userRole" : null
  },
  "status" : "success"
}

Status Codes

Status Codes

Description

200

Request succeeded

Error Codes

See Error Codes.