Queries the hosts that a user group is authorized or not authorized to manage.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
yundun-bastionhost:ListHostsForUserGroup | Read |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The category of the host that you want to query. Valid values:
| bastionhost-cn-st220aw**** |
RegionId | string | No | The endpoint of the host that you want to query. You can set this parameter to a domain name or an IP address. Only exact match is supported. | cn-hangzhou |
Mode | string | No | The operating system of the host. Valid values:
| Authorized |
UserGroupId | string | Yes | The number of the page to return. Default value: 1. | 1 |
PageNumber | string | No | The endpoint type of the host. Valid values:
| 1 |
PageSize | string | No | The number of entries to return on each page. The value of the PageSize parameter must not exceed 100. Default value: 20. If you leave the PageSize parameter empty, 20 entries are returned on each page. Note
We recommend that you do not leave the PageSize parameter empty.
| 20 |
HostAddress | string | No | The operating system of the host that you want to query. Valid values:
| 192.168.XX.XX |
HostName | string | No | The ID of the Bastionhost instance where you want to query the hosts that the user group is authorized or not authorized to manage. Note
You can call the DescribeInstances operation to query the ID of the Bastionhost instance.
| abc |
OSType | string | No | The internal endpoint of the host. The value is a domain name or an IP address. | Linux |
The total number of hosts returned.
Response parameters
Examples
Sample success responses
JSON
format
{
"TotalCount": 10,
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"Hosts": [
{
"Comment": "comment",
"ActiveAddressType": "Public",
"HostPublicAddress": "10.158.XX.XX",
"HostName": "host1",
"HostPrivateAddress": "192.168.XX.XX",
"OSType": "Linux",
"HostId": "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. |
For a list of error codes, visit the Service error codes.