Consulta de la lista de nodos del contenedor
Función
Esta API se utiliza para consultar la lista de nodos del contenedor.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v5/{project_id}/container/nodes
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto del tenant Mínimo: 1 Máximo: 256 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enterprise_project_id |
No |
String |
ID de proyecto empresarial. Para consultar todos los proyectos empresariales, establezca este parámetro en all_granted_eps. Valor predeterminado: 0 Mínimo: 1 Máximo: 256 |
offset |
No |
Integer |
Desfase, que especifica la posición inicial del registro que se va a devolver. El valor debe ser un número no menor que 0. El valor predeterminado es 0. Mínimo: 0 Máximo: 2000000 Valor predeterminado: 0 |
limit |
No |
Integer |
Número de registros mostrados en cada página. Mínimo: 10 Máximo: 200 Valor predeterminado: 10 |
host_name |
No |
String |
Nombre del nodo. Mínimo: 0 Máximo: 128 |
agent_status |
No |
String |
Estado de agente. Puede ser:
Mínimo: 1 Máximo: 32 |
protect_status |
No |
String |
Estado de protección. Su valor puede ser:
Mínimo: 1 Máximo: 32 |
container_tags |
No |
String |
Etiqueta, que se utiliza para identificar el contenedor de CCE y los nodos autoconstruidos.
Mínimo: 1 Máximo: 32 |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. Mínimo: 1 Máximo: 32768 |
region |
Sí |
String |
ID de región Mínimo: 0 Máximo: 128 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total_num |
Integer |
Número total de nodos de contenedor Mínimo: 0 Máximo: 65535 |
data_list |
Array of ContainerNodeInfo objects |
Lista de nodos de contenedor Longitud de matriz: 0 - 65535 |
Parámetro |
Tipo |
Descripción |
---|---|---|
agent_id |
String |
ID de agente Mínimo: 0 Máximo: 64 |
host_id |
String |
ID del servidor Mínimo: 0 Máximo: 128 |
host_name |
String |
Nombre del nodo Mínimo: 0 Máximo: 128 |
host_status |
String |
Estado del servidor. Las opciones son las siguientes:
Mínimo: 1 Máximo: 32 |
agent_status |
String |
Estado de agente. Puede ser:
Mínimo: 1 Máximo: 32 |
protect_status |
String |
Estado de protección. Su valor puede ser:
Mínimo: 1 Máximo: 32 |
protect_interrupt |
Boolean |
Si se interrumpe la protección |
container_tags |
String |
Etiqueta, que se utiliza para identificar el contenedor de CCE y los nodos autoconstruidos.
Mínimo: 1 Máximo: 32 |
private_ip |
String |
Dirección IP privada Mínimo: 0 Máximo: 128 |
public_ip |
String |
Dirección IP elástica (EIP) Mínimo: 0 Máximo: 128 |
resource_id |
String |
ID de cuota HSS (UUID) Mínimo: 0 Máximo: 128 |
group_name |
String |
ID de grupo de servidores Mínimo: 1 Máximo: 128 |
enterprise_project_name |
String |
Nombre del proyecto de empresa Mínimo: 0 Máximo: 256 |
detect_result |
String |
Resultado del análisis del servidor. Las opciones son las siguientes:
Mínimo: 1 Máximo: 32 |
asset |
Integer |
Riesgos de activos Mínimo: 0 Máximo: 2097152 |
vulnerability |
Integer |
Vulnerabilidades Mínimo: 0 Máximo: 2097152 |
intrusion |
Integer |
Riesgos de intrusión Mínimo: 0 Máximo: 2097152 |
policy_group_id |
String |
ID de grupo de política Mínimo: 1 Máximo: 128 |
policy_group_name |
String |
Nombre del grupo de políticas Mínimo: 1 Máximo: 128 |
Solicitudes de ejemplo
Esta API se utiliza para consultar la lista de nodos del contenedor. Si no se establece el parámetro de límite, se devuelven 10 registros de forma predeterminada.
GET https://{endpoint}/v5/{project_id}/container/nodes
Ejemplo de respuestas
Código de estado: 200
respuesta de éxito
{ "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)" } ] }
Código de ejemplo del SDK
El código de ejemplo del SDK es el siguiente.
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 48 49 50 51 52 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListContainerNodesRequest request = new ListContainerNodesRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withHostName("<host_name>"); request.withAgentStatus("<agent_status>"); request.withProtectStatus("<protect_status>"); request.withContainerTags("<container_tags>"); 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()); } } } |
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 33 34 35 36 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListContainerNodesRequest() request.enterprise_project_id = "<enterprise_project_id>" request.offset = <offset> request.limit = <limit> request.host_name = "<host_name>" request.agent_status = "<agent_status>" request.protect_status = "<protect_status>" request.container_tags = "<container_tags>" 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) |
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 38 39 40 41 42 43 44 45 46 47 48 49 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListContainerNodesRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest agentStatusRequest:= "<agent_status>" request.AgentStatus = &agentStatusRequest protectStatusRequest:= "<protect_status>" request.ProtectStatus = &protectStatusRequest containerTagsRequest:= "<container_tags>" request.ContainerTags = &containerTagsRequest response, err := client.ListContainerNodes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
Más información
Para obtener un código de ejemplo del SDK de más lenguajes de programación, consulte la pestaña Código de ejemplo en API Explorer. El código de ejemplo del SDK se puede generar automáticamente.
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
respuesta de éxito |
Códigos de error
Consulte Códigos de error.