Modifies the name or description of a specified host group.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 resourcesis used in the Resource type column of the operation.
- Condition keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
| Operate | access level | Resource type | conditional keyword | Association operation |
|---|---|---|---|---|
| yundun-bastionhost:ModifyHostGroup | Write |
|
| without |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the Bastionhost instance where you want to modify the information of the host group. NoteYou can call the DescribeInstances operation to query the ID of the Bastionhost instance. | bastionhost-cn-st220aw**** |
| RegionId | string | No | The region ID of the Bastionhost instance where you want to modify the information of the host group. NoteFor more information about the mapping between region IDs and region names, see Regions and zones. | cn-hangzhou |
| HostGroupId | string | Yes | The ID of the host group that you want to modify. NoteYou can call the ListHostGroups operation to query the ID of the host group. | 1 |
| HostGroupName | string | No | The new name of the host group. The name can be up to 128 characters in length. | Group01 |
| Comment | string | No | The new description of the host group. The value can be up to 500 characters in length. | comment |
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 parameters
Example
Normal return example
JSONFormat
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}Error codes
| Http code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | The argument is invalid. |
| 404 | HostGroupNotFound | The host group is not found. | The host group is not found. |
| 500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the API error center.