Querying the Container Node List
Function
This API is used to query the container node list.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/container/nodes
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
offset |
No |
Integer |
Definition Start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value 0 |
limit |
No |
Integer |
Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10 |
host_name |
No |
String |
Definition Node name. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
agent_status |
No |
String |
Definition Agent status. Constraints N/A Range The options are as follows: Default Value N/A |
protect_status |
No |
String |
Definition Protection status. Constraints N/A Range The options are as follows: Default Value N/A |
container_tags |
No |
String |
Definition Tag used to identify a CCE node or user-built node. Constraints N/A Range The options are as follows: Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
region |
No |
String |
Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Definition Total number of container nodes. Range Value range: 0 to 65,535 |
data_list |
Array of ContainerNodeInfo objects |
Definition Container node list. Range Value range: 0 to 65,535 |
Parameter |
Type |
Description |
---|---|---|
agent_id |
String |
Definition Agent ID Range The value can contain 0 to 64 characters. |
host_id |
String |
Definition Server ID. Range The value can contain 0 to 128 characters. |
host_name |
String |
Definition Node name. Range The value can contain 0 to 128 characters. |
host_status |
String |
Definition Server status. Range The options are as follows: |
agent_status |
String |
Definition Agent status. Range The options are as follows: |
protect_status |
String |
Definition Protection status. Range The options are as follows: |
protect_interrupt |
Boolean |
Definition Whether protection is interrupted. Range |
protect_degradation |
Boolean |
Definition Whether protection is degraded. Range |
degradation_reason |
String |
Definition Protection degradation cause. Range The value can contain 1 to 32 characters. |
container_tags |
String |
Definition Tag used to identify a CCE node or user-built node. Range The options are as follows: |
private_ip |
String |
Definition Private IP address. Range The value can contain 0 to 128 characters. |
public_ip |
String |
Definition EIP. Range The value can contain 0 to 128 characters. |
resource_id |
String |
Definition HSS quota ID (UUID). Range The value can contain 0 to 128 characters. |
group_name |
String |
Definition Server group name. Range The value can contain 1 to 128 characters. |
enterprise_project_name |
String |
Definition Enterprise project name. Range The value can contain 0 to 256 characters. |
detect_result |
String |
Definition Cloud server security scan result. Range The options are as follows: |
asset |
Integer |
Definition Asset risks. Range Value range: 0 to 2,097,152 |
vulnerability |
Integer |
Definition Vulnerability risks. Range Value range: 0 to 2,097,152 |
intrusion |
Integer |
Definition Intrusion risks. Range Value range: 0 to 2,097,152 |
policy_group_id |
String |
Definition Policy group ID. Range The value can contain 1 to 128 characters. |
policy_group_name |
String |
Definition Policy group name. Range The value can contain 1 to 128 characters. |
Example Requests
This API is used to query the container node list. If the limit parameter is not set, 10 records are returned by default.
GET https://{endpoint}/v5/{project_id}/container/nodes
Example Responses
Status code: 200
Request succeeded.
{ "total_num" : 1, "data_list" : [ { "agent_id" : "2d0fe7824005bf001220ad9d892e86f8af44XXXXXXXXXXX", "agent_status" : "online", "host_id" : "host_id", "host_name" : "host_name", "host_status" : "ACTIVE", "protect_status" : "opened", "protect_interrupt" : false, "private_ip" : "192.168.0.114", "public_ip" : "100.85.218.122", "resource_id" : "ef5eb4fd-7376-48ac-886f-16fd057776f3", "group_name" : "as(All projects)", "enterprise_project_name" : "default", "detect_result" : "risk", "asset" : 0, "vulnerability" : 14, "intrusion" : 0, "policy_group_id" : "ce4d5e95-0cbf-4102-9c77-ef1bcb6b35aa", "policy_group_name" : "tenant_linux_enterprise_default_policy_group (All projects)" } ] }
SDK Sample Code
The SDK sample code is as follows.
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.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListContainerNodesSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListContainerNodesRequest request = new ListContainerNodesRequest(); try { ListContainerNodesResponse response = client.listContainerNodes(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()); } } } |
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 huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListContainerNodesRequest() response = client.list_container_nodes(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListContainerNodesRequest{} response, err := client.ListContainerNodes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Request succeeded. |
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