All Products
Search

This Product

    Bastionhost:ModifyHost

    Document Center

    Bastionhost:ModifyHost

    Last Updated:Sep 29, 2026

    Updates the address, name, operating system type, and description of a host.

    Operation description

    This operation updates the basic information of on-premises hosts, ECS hosts, and hosts in dedicated ApsaraDB RDS clusters.

    Note

    If you update the basic information of an ECS host or a host in a dedicated ApsaraDB RDS cluster, the changes may be overwritten. This is because Bastionhost periodically synchronizes the basic information of ECS hosts and hosts in dedicated ApsaraDB RDS clusters.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-bastionhost:ModifyHost

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The ID of the Bastionhost instance to which the host belongs.

    Note

    You can call the DescribeInstances operation to query the instance ID.

    bastionhost-cn-st220aw****
    RegionId

    string

    No

    The region ID of the Bastionhost instance to which the host belongs.

    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 to be updated.

    Note

    You can call the ListHosts operation to query the host ID.

    1
    HostPrivateAddress

    string

    No

    The new private network address of the host. You can specify a domain name or an IP address.

    193.168.XX.XX
    HostPublicAddress

    string

    No

    The new public address of the host. You can specify a domain name or an IP address.

    200.1.XX.XX
    OSType

    string

    No

    The new operating system type of the host. Valid values:

    • Linux

    • Windows

    Linux
    HostName

    string

    No

    The new name of the host. The name can be up to 128 characters in length.

    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 network domain to which the host belongs.

    Note

    You can call the ListNetworkDomains operation to query the network domain ID.

    1
    PrefKex

    string

    No

    The preferred key exchange algorithm for the host. You can modify this parameter only when the OSType parameter is set to Linux. Valid values:

    • default: Default mode.

    • diffie-hellman-group1-sha1: Compatibility mode for the diffie-hellman-group1-sha1 algorithm.

    • diffie-hellman-group14-sha1: Compatibility mode for the diffie-hellman-group14-sha1 algorithm.

    • diffie-hellman-group-exchange-sha1: Compatibility mode for the diffie-hellman-group-exchange-sha1 algorithm.

    default
    ProjectId

    integer

    No

    The project ID.

    3

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    Examples

    Success response

    JSON format

    {
  "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.
    500 InternalError An unknown error occurred. An unknown error occurred.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.