Use ModifyHostsActiveAddressType to change the active address type of hosts - Bastionhost - Alibaba Cloud - Bastionhost

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

update

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the Bastionhost instance to which the host whose endpoint type you want to modify belongs. Note You can invoke the DescribeInstances operation to obtain the value of this parameter.	bastionhost-cn-st220aw***
RegionId	string	No	The area ID of the Bastionhost instance to which the host whose endpoint type you want to modify belongs. Note For more information about the mapping between area IDs and area names, see Regions and active zones.	cn-hangzhou
HostIds	string	Yes	The IDs of the hosts whose endpoint types you want to modify. The value is a character string in JSON format. You can specify up to 100 host IDs. You can invoke the ListHosts operation to obtain the value of this parameter.	["1","2"]
ActiveAddressType	string	Yes	The new endpoint type of the host. Valid values: Public: Internet Private: private network	Private
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Results	array<object>	The operation result.
	object
Code	string	The result code of the operation. Valid values: OK: The operation is successful. UNEXPECTED: An unknown error occurred. INVALID_ARGUMENT: A request parameter is invalid. OBJECT_NOT_FOUND: The specified object does not exist. OBJECT_AlREADY_EXISTS: The specified object already exists.	OK
Message	string	[Deprecated] This parameter is deprecated and can be ignored.	None
HostId	string	The host ID.	1

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Results": [
    {
      "Code": "OK",
      "Message": "None",
      "HostId": "1"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
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.