Importing a Host to an Environment

Updated on 2025-05-27 GMT+08:00

View PDF

Function

This API is used to import a host to an environment.

Calling Method

For details, see Calling APIs.

URI

POST /v1/applications/{application_id}/environments/{environment_id}/hosts/import

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
application_id	Yes	String	Application ID
environment_id	Yes	String	Environment ID

Request Parameters

**Table 2** Request header 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	Host cluster ID
host_ids	Yes	Array of strings	ID list of the hosts to be imported

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Request success or failure status
result	Array of strings	ID list of the imported hosts

Example Requests

https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments/666ec038a53c4b9f899823747a7130e8/hosts/import

{
  "group_id" : "4b0cb2f098174d38b0c15645c13eae6f",
  "host_ids" : [ "8e1eb7f010d4442ca150e3a1a5d96d94" ]
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "result" : [ "c5fa45c92c0849229d003d98f52617eb" ]
}

Status Codes


Status Code	Description
200	OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Environments

Previous topic: Querying Environment Details

Next topic: Deleting a Host from an Environment

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel