GetGroup

Last Updated: Aug 26, 2016

Interface description

 Obtains user group information.

Request parameters

Action

  • Type: String
  • Required: Yes
  • Description: Operation name. Value: GetGroup

GroupName

  • Type: String
  • Required: Yes
  • Description: Group name.Example: dev.
  • Format: ^[a-zA-Z0-9\-]+$

Return parameters

Group

  • Type: [Group Type] (28747)
  • Description: Group information.

Required permissions

Action

ram:GetGroup

Resource

acs:ram:*:${AccountId}:group/${GroupName}

Error messages

InvalidParameter.GroupName.InvalidChars
  • HTTP Status:400
  • Error Message:The parameter - “GroupName” contains invalid chars.
InvalidParameter.GroupName.Length
  • HTTP Status:400
  • Error Message:The parameter - “GroupName” beyond the length limit.
EntityNotExist.Group
  • HTTP Status:404
  • Error Message:The group does not exist.

Operation examples

Request example

  1. https://ram.aliyuncs.com/?Action=GetGroup
  2. &GroupName=Dev-Team
  3. &<Public request parameters>

Return example

XML format

  1. <GetGroupResponse>
  2. <RequestId>D4065824-E422-3ED6-68B1-1AF7D5C7804C</RequestId>
  3. <Group>
  4. <GroupName>Dev-Team</GroupName>
  5. <Comments>Development team</Comments>
  6. <CreateDate>2015-01-23T12:33:18Z</CreateDate>
  7. <UpdateDate>2015-02-11T03:15:21Z</UpdateDate>
  8. </Group>
  9. </GetGroupResponse>

JSON format

  1. {
  2. "RequestId": "D4065824-E422-3ED6-68B1-1AF7D5C7804C",
  3. "Group": {
  4. "GroupName": "Dev-Team",
  5. "Comments": "Development team",
  6. "CreateDate": "2015-01-23T12:33:18Z",
  7. "UpdateDate": "2015-02-11T03:15:21Z"
  8. }
  9. }
Thank you! We've received your feedback.