查询容器节点列表
功能介绍
查询容器节点列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/container/nodes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
offset |
否 |
Integer |
参数解释: 指定返回记录的开始位置 约束限制: 不涉及 取值范围: 取值0-2000000 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
host_name |
否 |
String |
参数解释: 节点名称 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
agent_status |
否 |
String |
参数解释: Agent状态 约束限制: 不涉及 取值范围: 包含如下3种。
默认取值: 不涉及 |
protect_status |
否 |
String |
参数解释: 防护状态 约束限制: 不涉及 取值范围: 包含如下2种。
默认取值: 不涉及 |
container_tags |
否 |
String |
参数解释: 用来识别cce节点或者自建节点的标签 约束限制: 不涉及 取值范围: 包含如下3种。
默认取值: 不涉及 |
请求参数
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
参数解释: 容器节点总数 取值范围: 取值0-65535 |
data_list |
Array of ContainerNodeInfo objects |
参数解释: 容器节点列表 取值范围: 取值0-65535 |
参数 |
参数类型 |
描述 |
---|---|---|
agent_id |
String |
参数解释: Agent ID 取值范围: 字符长度0-64位 |
host_id |
String |
参数解释: 服务器ID 取值范围: 字符长度0-128位 |
host_name |
String |
参数解释: 节点名称 取值范围: 字符长度0-128位 |
host_status |
String |
参数解释: 服务器状态 取值范围: 包含如下4种。
|
agent_status |
String |
参数解释: Agent状态 取值范围: 包含如下3种。
|
protect_status |
String |
参数解释: 防护状态 取值范围: 包含如下2种。
|
protect_interrupt |
Boolean |
参数解释: 防护是否中断 取值范围:
|
protect_degradation |
Boolean |
参数解释: 防护是否降级 取值范围:
|
degradation_reason |
String |
参数解释: 防护降级原因 取值范围: 字符长度1-32位 |
container_tags |
String |
参数解释: 用来识别cce容器节点和自建节点的标签 取值范围: 包含如下3种。
|
private_ip |
String |
参数解释: 私有IP地址 取值范围: 字符长度0-128位 |
public_ip |
String |
参数解释: 弹性公网IP地址 取值范围: 字符长度0-128位 |
resource_id |
String |
参数解释: 主机安全配额ID(UUID) 取值范围: 字符长度0-128位 |
group_name |
String |
参数解释: 服务器组名称 取值范围: 字符长度1-128位 |
enterprise_project_name |
String |
参数解释: 所属企业项目名称 取值范围: 字符长度0-256位 |
detect_result |
String |
参数解释: 云主机安全检测结果 取值范围: 包含如下4种。
|
asset |
Integer |
参数解释: 资产风险 取值范围: 取值0-2097152 |
vulnerability |
Integer |
参数解释: 漏洞风险 取值范围: 取值0-2097152 |
intrusion |
Integer |
参数解释: 入侵风险 取值范围: 取值0-2097152 |
policy_group_id |
String |
参数解释: 策略组ID 取值范围: 字符长度1-128位 |
policy_group_name |
String |
参数解释: 策略组名称 取值范围: 字符长度1-128位 |
请求示例
查询容器节点列表,不传limit参数默认返回10条。
GET https://{endpoint}/v5/{project_id}/container/nodes
响应示例
状态码:200
请求已成功
{ "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代码示例
SDK代码示例如下。
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
错误码
请参见错误码。