Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtaining a Repository Short ID to Generate the Details Page URL
Updated on 2025-03-28 GMT+08:00
View PDF
Share

Obtaining a Repository Short ID to Generate the Details Page URL

Function

This API is used to obtain a repository short ID, which is used to obtain the URL of the repository details page.

URI

GET /v1/repositories/repoid

Table 1 Query parameters

Parameter

Mandatory

Type

Description

group_name

Yes

String

Repository group name (the segment between the domain name and repository name in a clone address. Example: Demo00228 in git@repo.alpha.devcloud.inhuawei.com:Demo00228/testword.git).

repository_name

Yes

String

Repository name

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory

Range:

1–100,000 characters.

Default value:

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Response error.

result

Integer

Response result.

status

String

Response status.
Table 4 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

Example Requests

GET https://{endpoint}/v1/repositories/repoid

Example Responses

Status code: 200

OK

{
  "result" : 468485,
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Repository