Querying a Host List (Recommended)
Function
This API is used to query a host list in a specified host cluster by ID.
Calling Method
For details, see Calling APIs.
URI
GET /v1/resources/host-groups/{group_id}/hosts
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key_field |
No |
String |
Fuzzy search information about the host name |
environment_id |
No |
String |
Environment ID |
page_index |
No |
Integer |
Page number |
page_size |
No |
Integer |
Number of items displayed on each page. The default value is 10. |
sort_key |
No |
String |
Sorting field: as_proxy|host_name|owner_name. If this parameter is left blank, the default sorting mode is used. |
sort_dir |
No |
String |
Sorting mode: DESC (default) and ASC. |
as_proxy |
No |
Boolean |
Proxy or not |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Host quantity |
status |
String |
Request success or failure status |
result |
Array of HostInfo objects |
Host information list |
Parameter |
Type |
Description |
---|---|---|
uuid |
String |
Host ID |
ip |
String |
Host IP address |
os |
String |
Host OS |
port |
Integer |
Port |
authorization |
HostAuthorizationBody object |
Log in to the host for authentication by password or key. |
permission |
PermissionHostDetailNew object |
Host-related permission details |
host_name |
String |
Host name |
as_proxy |
Boolean |
Proxy or not |
group_id |
String |
Host cluster ID |
proxy_host_id |
String |
Proxy ID |
owner_id |
String |
Host owner ID |
owner_name |
String |
Host owner name |
proxy_host |
HostInfo object |
Proxy details |
connection_status |
String |
Connectivity status |
create_time |
String |
Creation time |
lastest_connection_time |
String |
Last connection time |
connection_result |
String |
Connectivity verification result |
nick_name |
String |
Host owner alias |
import_status |
String |
Import status |
env_count |
Integer |
Number of associated environments |
Parameter |
Type |
Description |
---|---|---|
username |
String |
Username. The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). |
password |
String |
Password. When the authentication type is 0, the password is mandatory. |
private_key |
String |
Key. When the authentication type is 1, the key is mandatory. |
trusted_type |
Integer |
Authentication type. 0 indicates password authentication, and 1 indicates key authentication. |
Parameter |
Type |
Description |
---|---|---|
can_view |
Boolean |
Whether you have the view permission |
can_edit |
Boolean |
Whether you have the edit permission |
can_delete |
Boolean |
Whether you have the delete permission |
can_add_host |
Boolean |
Whether you have the permission to add hosts |
can_copy |
Boolean |
Whether you have the permission to clone hosts |
Example Requests
https://{endpoint}/v1/resources/host-groups/317aea99cf2944fcacf88b34ef771843/hosts?page_index=1&page_size=10&sort_key=host_name&sort_dir=ASC&as_proxy=false
Example Responses
Status code: 200
OK: The request is successful.
{ "result" : [ { "host_name" : "100.101.28.203", "ip" : "100.101.28.203", "port" : 22, "os" : "linux", "authorization" : { "username" : "root", "password" : null, "private_key" : null, "trusted_type" : 0 }, "permission" : { "can_view" : true, "can_edit" : true, "can_delete" : true, "can_add_host" : true, "can_copy" : true }, "uuid" : "2cc913cc9a494f09b7320801ebacad02", "group_id" : "ab7647b0863c4e969c8949d38d591339", "as_proxy" : false, "proxy_host_id" : "", "owner_id" : "6baa7454109d47c192f22078fe6cda20", "owner_name" : "devcloud_devcloud_l00490255_01", "connection_status" : "success", "create_time" : "2021-04-15 11:01:51", "connection_result" : "Connection established", "lastest_connection_time" : "2021-04-15 11:02:00", "nick_name" : "A/B Side Account", "proxy_host" : null, "import_status" : null, "env_count" : 1 } ], "total" : 1, "status" : "success" }
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 |
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 ListNewHostsSolution { 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(); ListNewHostsRequest request = new ListNewHostsRequest(); request.withGroupId("{group_id}"); try { ListNewHostsResponse response = client.listNewHosts(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 |
# 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 = ListNewHostsRequest() request.group_id = "{group_id}" response = client.list_new_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 |
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.ListNewHostsRequest{} request.GroupId = "{group_id}" response, err := client.ListNewHosts(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