Modifies information about a host. The information includes the address, name, and description of the host and the operating system that the host runs.
Operation description
You can call the ModifyHost operation to modify the basic information about a host in a data center, an Elastic Compute Service (ECS) instance, or a host in an ApsaraDB MyBase dedicated cluster.
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 Resourcesis 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:ModifyHost | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the bastion host on which you want to modify the information about the host. 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 on which you want to modify the information about the host. Note
For more information about the mapping between region IDs and region names, see Regions and zones.
| cn-hangzhou |
| HostId | string | Yes | The ID of the host. Note
You can call the ListHosts operation to query the ID of the host.
| 1 |
| HostPrivateAddress | string | No | The new internal endpoint of the host. You can set this parameter to a domain name or an IP address. | 193.168.XX.XX |
| HostPublicAddress | string | No | The new public endpoint of the host. You can set this parameter to a domain name or an IP address. | 200.1.XX.XX |
| OSType | string | No | The new operating system of the host. Valid values:
| Linux |
| HostName | string | No | The new name of the host. The name can be up to 128 characters. | TestHost |
| Comment | string | No | The new description of the host. The description can be up to 500 characters in length. | Host for test. |
| NetworkDomainId | string | No | The ID of the new network domain to which the host belongs. Note
You can call the ListNetworkDomains operation to query the network domain ID.
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | The argument is invalid. |
| 400 | HostNotFound | The host is not found. | The host is not found. |
| 500 | InternalError | An unknown error occurred. | An unknown error occurred. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-11-27 | The Error code has changed. The request parameters of the API has changed | View Change Details |