All Products
Search
Document Center

Bastionhost:GetUserGroup

Last Updated:Apr 22, 2026

Retrieves the details of a user group in a bastion host.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The ID of the bastion host in which you want to query the details of the user group.

Note

You can call the DescribeInstances operation to query the ID of the bastion host.

bastionhost-cn-st220aw****

RegionId

string

No

The region ID of the bastion host in which you want to query the details of the user group.

Note

For more information about the mapping between region IDs and region names, see Regions and zones.

cn-hangzhou

UserGroupId

string

Yes

The ID of the user group.

Note

You can call the ListUserGroups operation to query the ID of the user group.

1

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters. For more information about sample requests, see the "Examples" section of this topic.

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

UserGroup

object

The details of the user group returned.

UserGroupName

string

The name of the user group.

UserGroup01

Comment

string

The description of the user group.

comment

UserGroupId

string

The ID of the group.

1

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "UserGroup": {
    "UserGroupName": "UserGroup01",
    "Comment": "comment",
    "UserGroupId": "1"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The argument is invalid. The argument is invalid.
500 InternalError An unknown error occurred. An unknown error occurred.
404 UserGroupNotFound The user group is not found. The user group is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.