Querying a Host List in an Environment
Function
This API is used to query a host list in an environment.
Calling Method
For details, see Calling APIs.
URI
GET /v1/applications/{application_id}/environments/{environment_id}/hosts
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
application_id |
Yes |
String |
Application ID |
|
environment_id |
Yes |
String |
Environment ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
key_field |
No |
String |
Fuzzy search by host name and IP address |
|
as_proxy |
No |
Boolean |
Proxy or not. true: Proxy. |
|
page_index |
No |
Integer |
Page number |
|
page_size |
No |
Integer |
Number of records on each page |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
status |
String |
Definition Request status (successful or failed). Range
|
|
total |
Integer |
Definition Total number. Range Digits only. |
|
result |
Array of EnvironmentHostInfo objects |
Definition Host information list in the environment. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
host_id |
String |
Definition Host ID. Range The value contains 32 characters. Only letters and digits are allowed. |
|
ip |
String |
Definition Host IP address, for example, 161.17.101.12. Range N/A |
|
port |
Integer |
Definition SSH port, for example, 22. Range N/A |
|
permission |
EnvironmentHostPermission object |
Definition Environment permission details. Range N/A |
|
group_id |
String |
Definition Host cluster ID. Range The value contains 32 characters. Only letters and digits are allowed. |
|
host_name |
String |
Definition Host name. Range N/A |
|
as_proxy |
Boolean |
Definition Agent or not. Range
|
|
proxy_host_id |
String |
Definition Agent ID. Range The value contains 32 characters. Only letters and digits are allowed. |
|
proxy_host_name |
String |
Definition Agent name. Range N/A |
|
owner_id |
String |
Definition Host owner ID. Range The value contains 32 characters. Only letters and digits are allowed. |
|
owner_name |
String |
Definition Host owner name. Range N/A |
|
connection_status |
String |
Definition Connectivity status. Range N/A |
|
lastest_connection_time |
String |
Definition Last connection time. Range N/A |
|
connection_result |
String |
Definition Connectivity verification result. Range N/A |
|
nick_name |
String |
Definition Creator nickname. Range N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
can_delete |
Boolean |
Definition Whether granted the delete permission. Range
|
|
can_deploy |
Boolean |
Definition Whether granted the deployment permission. Range
|
|
can_edit |
Boolean |
Definition Whether granted the edit permission. Range
|
|
can_manage |
Boolean |
Definition Whether granted the permission management control. Range
|
|
can_view |
Boolean |
Definition Whether granted the view permission. Range
|
Example Requests
https://{endpoint}/v1/applications/e1d7b7388b4641e2a027f5673fd6093b/environments/82c4eb8c522d42969a3da30123e1ecba/hosts?page_index=1&page_size=10&key_field=
Example Responses
Status code: 200
OK: The request is successful.
{
"status" : "success",
"result" : [ {
"ip" : "100.85.172.31",
"port" : 22,
"permission" : {
"can_view" : true,
"can_edit" : true,
"can_delete" : true,
"can_deploy" : true,
"can_manage" : true
},
"host_id" : "13c208e61c9541ab9895f450fd1cbf7c",
"host_name" : "test",
"as_proxy" : false,
"group_id" : "2a8c2da888c04a5eaff10d0787c90ea4",
"proxy_host_id" : "",
"proxy_host_name" : null,
"owner_id" : "6baa7454109d47c192f22078fe6cda20",
"owner_name" : "devcloud_devcloud_l00490255_01",
"nick_name" : "devcloud_devcloud_l00490255_01",
"connection_status" : "failed",
"connection_result" : "Connection failed",
"lastest_connection_time" : "2024-05-31 14:47:52"
} ],
"total" : 1
}
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class ListEnvironmentHostsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); ListEnvironmentHostsRequest request = new ListEnvironmentHostsRequest(); request.withApplicationId("{application_id}"); request.withEnvironmentId("{environment_id}"); try { ListEnvironmentHostsResponse response = client.listEnvironmentHosts(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListEnvironmentHostsRequest() request.application_id = "{application_id}" request.environment_id = "{environment_id}" response = client.list_environment_hosts(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListEnvironmentHostsRequest{} request.ApplicationId = "{application_id}" request.EnvironmentId = "{environment_id}" response, err := client.ListEnvironmentHosts(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot