Docs
api
Access Control(IAM)
GetGroup

Query User Group Details - GetGroup

Overview

Query User Group Details

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetGroup.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
GroupNamestringUser Group NameYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
GroupGroupUser Group Detail InformationYes

Data Model

Group

Field NameTypeDescription InformationRequired
GroupNamestringUser Group NameYes
DescriptionstringUser Group Description InformationYes
CreatedAtintUser Group Creation TimestampNo

Example

Request Example

https://api.ucloud-global.com/?Action=GetGroup
&GroupName=HXhJgaii

Response Example

{
  "Action": "GetGroupResponse",
  "Group": {},
  "Message": "rJOrKCBg",
  "RetCode": 0
}