All Products
Search

This Product

    Bastionhost:ModifyHost

    Document Center

    Bastionhost:ModifyHost

    Last Updated:Apr 18, 2024

    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.

    Note The basic information about ECS instances and hosts in ApsaraDB MyBase dedicated clusters within your Alibaba Cloud account is synchronized to Bastionhost on a regular basis. After you modify the basic information about an ECS instance or a host in an ApsaraDB MyBase dedicated cluster, the modification result may be overwritten by the synchronized information.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    yundun-bastionhost:ModifyHostWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    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****
    RegionIdstringNo

    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
    HostIdstringYes

    The ID of the host.

    Note You can call the ListHosts operation to query the ID of the host.
    		1
    HostPrivateAddressstringNo

    The new internal endpoint of the host. You can set this parameter to a domain name or an IP address.

    		193.168.XX.XX
    HostPublicAddressstringNo

    The new public endpoint of the host. You can set this parameter to a domain name or an IP address.

    		200.1.XX.XX
    OSTypestringNo

    The new operating system of the host. Valid values:

    • Linux
    • Windows
    		Linux
    HostNamestringNo

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

    		TestHost
    CommentstringNo

    The new description of the host. The description can be up to 500 characters in length.

    		Host for test.
    NetworkDomainIdstringNo

    The ID of the new network domain to which the host belongs.

    		1

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		EC9BF0F4-8983-491A-BC8C-1B4DD94976DE

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidParameterThe argument is invalid.The argument is invalid.
    400HostNotFoundThe host is not found.The host is not found.
    500InternalErrorAn unknown error occurred.An unknown error occurred.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-11-27The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 500
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: NetworkDomainId