Editing Host Information in a Host Cluster
Function
This API is used to edit host information in a host cluster by ID.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/resources/host-groups/{group_id}/hosts/{host_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_id |
Yes |
String |
Host cluster ID |
host_id |
Yes |
String |
Host ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). |
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
as_proxy |
No |
Boolean |
Proxy host or not |
authorization |
No |
Log in to the host for authentication by password or key. |
|
host_name |
Yes |
String |
Host name |
ip |
Yes |
String |
An IPv4 or IPv6 IP address. |
port |
Yes |
Integer |
SSH Port, for example, 22. |
proxy_host_id |
No |
String |
Proxy host ID |
sync |
No |
Boolean |
Whether to sync host information |
install_icagent |
No |
Boolean |
Whether to install ICAgent |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
username |
Yes |
String |
Username. The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). |
password |
No |
String |
Password. When the authentication type is 0, the password is mandatory. |
private_key |
No |
String |
Key. When the authentication type is 1, the key is mandatory. |
trusted_type |
Yes |
Integer |
Authentication type. 0 indicates password authentication, and 1 indicates key authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Request success or failure status |
id |
String |
Host ID |
Example Requests
https://{endpoint}/v1/resources/host-groups/6bec5f67ab9b4c34a21c7ffe0b0191c8/hosts/a94facdc4b1e40d799dbe6de91167072 { "as_proxy" : false, "host_name" : "hostName", "install_icagent" : true, "ip" : "100.101.28.215", "port" : 22, "proxy_host_id" : "", "authorization" : { "username" : "root", "password" : "*****", "private_key" : "", "trusted_type" : 0 } }
Example Responses
Status code: 200
OK: The request is successful.
{ "status" : "success", "id" : "a94facdc4b1e40d799dbe6de91167072" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.