All Products
Search

This Product

    Bastionhost:ModifyNetworkDomain

    Document Center

    Bastionhost:ModifyNetworkDomain

    Last Updated:Sep 29, 2026

    Modifies the basic information of a network domain.

    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:ModifyNetworkDomain

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID of the Bastionhost instance to which the network domain to be modified belongs.

    Note

    You can invoke the DescribeInstances operation to obtain the parameter value.

    bastionhost-cn-x0r3hyr3f09
    RegionId

    string

    No

    The region ID of the Bastionhost instance to which the network domain to be modified belongs.

    Note

    For more information about the mapping between region IDs and region names, see Regions and zones.

    cn-hangzhou
    NetworkDomainId

    string

    Yes

    The ID of the network domain to be modified.

    3
    NetworkDomainName

    string

    No

    The new name of the network domain.

    test
    NetworkDomainType

    string

    No

    The new type of the network domain. Valid values:

    • Direct: Direct connection.

    • Proxy: Proxy.

    Proxy
    Comment

    string

    No

    The new description of the network domain.

    xxx
    Proxies

    array<object>

    No

    The information about the proxy servers in the network domain.

    object

    No

    User

    string

    No

    The new username of the proxy server.

    test
    NodeType

    string

    No

    The type of the proxy server node to be modified. Valid values:

    • Master: Primary proxy server.

    • Slave: Secondary proxy server.

    Slave
    ProxyType

    string

    No

    The new proxy type. Valid values:

    • SSHProxy: SSH proxy.

    • HTTPProxy: HTTP proxy.

    • Socks5Proxy: SOCKS5 proxy.

    HTTPProxy
    Address

    string

    No

    The new address of the proxy server.

    114.21**.**
    Password

    string

    No

    The new password of the proxy server account.

    ***
    Port

    integer

    No

    The new Server Port of the proxy server.

    22
    ProjectId

    integer

    No

    The project ID.

    3

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    ED49CD1E-3510-5E5C-9133-E2067B656501

    Examples

    Success response

    JSON format

    {
  "RequestId": "ED49CD1E-3510-5E5C-9133-E2067B656501"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The argument is invalid. The argument is invalid.
    400 NetworkDomainAlreadyExists The network domain already exists. The network domain already exists.
    500 InternalError An unknown error occurred. An unknown error occurred.
    404 NetworkDomainNotFound The network domain is not found. The network domain is not found.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.