Obtaining Repository Group Information

Function

This API is used to obtain repository group information.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsrepo:group:getGroup	Read	-	-	-	-

URI

GET https://{hostURL}/v4/{project_id}/groups/{group_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition You can call the API used to query project list to query the project list to obtain the unique 32-character UUID of the project. Range A string that can contain 32 characters.
group_id	Yes	Integer	Definition Repository group ID, which is the numeric ID next to Group ID on the repository group homepage. Default Value N/A Value range: 1~2147483647

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token 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. Constraints N/A Range A string that can contain 1 to 100,000 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
creator_id	Integer	Creator ID Value range: 1~2147483647
project_id	String	Project ID
created_at	String	Creation time
description	String	Description
full_name	String	Repository group full name
ancestor_ids	Array of integers	Repository group path ID Value range: 1~2147483647
ancestor_names	Array of strings	Repository group path name
id	Integer	Repository group ID Value range: 1~2147483647
members_count	Integer	Number of repository group members Value range: 1~1000
name	String	Repository group name
repository_count	Integer	Number of repositories Value range: 1~2147483647
star_count	Integer	Followed count Value range: 1~2147483647
starred	Boolean	Follow or not
subgroup_count	Integer	Number of sub-groups Value range: 1~2147483647
visibility	String	Visibility. The value can be private or public Enumeration values: public private
sum	GroupSumDto object	Count

**Table 4** GroupSumDto
Parameter	Type	Description
open_merge_requests_count	Integer	Number of MRs in the open status Value range: 0~2147483647

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Example Requests

/v4/72271b5446614062a01b8be944c9f372/groups/13254

Example Responses

Status code: 200

{
  "creator_id" : 9125,
  "project_id" : "1a92b5c48d914f11893ca983d01a1d33",
  "description" : "",
  "full_name" : "1a92b5c48d914f11893ca983d01a1d33 / q / 1 / 2",
  "ancestor_ids" : [ 2111665683, 2111665684, 2111665685 ],
  "ancestor_names" : [ "q", "1", "2" ],
  "id" : 2111665685,
  "members_count" : 2,
  "name" : "2",
  "repository_count" : 1,
  "star_count" : 0,
  "starred" : false,
  "subgroup_count" : 0,
  "visibility" : "private",
  "sum" : {
    "open_merge_requests_count" : 0
  }
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permission and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Group Not Found"
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Bad Request
404	Not Found

Error Codes

See Error Codes.

Parent topic: Group

Previous topic: Transferring a Repository Group

Next topic: Deleting a Repository Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot