Consulta da lista de nós de container
Função
Essa API é usada para consultar a lista de nós de container.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v5/{project_id}/container/nodes
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto do locatário Mínimo: 1 Máximo: 256 |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
enterprise_project_id |
Não |
String |
ID do projeto empresarial. Para consultar todos os projetos empresariais, defina este parâmetro como all_granted_eps. Padrão: 0 Mínimo: 1 Máximo: 256 |
offset |
Não |
Integer |
Deslocamento, que especifica a posição inicial do registro a ser retornado. O valor deve ser um número não menor que 0. O valor padrão é 0. Mínimo: 0 Máximo: 2000000 Padrão: 0 |
limit |
Não |
Integer |
Número de registros exibidos em cada página. Mínimo: 10 Máximo: 200 Padrão: 10 |
host_name |
Não |
String |
Nome do nó. Mínimo: 0 Máximo: 128 |
agent_status |
Não |
String |
Status de agente. Pode ser:
Mínimo: 1 Máximo: 32 |
protect_status |
Não |
String |
Status de proteção. Seu valor pode ser:
Mínimo: 1 Máximo: 32 |
container_tags |
Não |
String |
Rótulo, que é usado para identificar o container do CCE e os nós autoconstruídos.
Mínimo: 1 Máximo: 32 |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. Mínimo: 1 Máximo: 32768 |
region |
Sim |
String |
ID da região Mínimo: 0 Máximo: 128 |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
total_num |
Integer |
Número total de nós de container Mínimo: 0 Máximo: 65535 |
data_list |
Array of ContainerNodeInfo objects |
Lista de nós de container Comprimento da matriz: 0–65535 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
agent_id |
String |
ID do agente Mínimo: 0 Máximo: 64 |
host_id |
String |
ID de servidor Mínimo: 0 Máximo: 128 |
host_name |
String |
Nome do nó Mínimo: 0 Máximo: 128 |
host_status |
String |
Status do servidor. As opções são as seguintes:
Mínimo: 1 Máximo: 32 |
agent_status |
String |
Status de agente. Pode ser:
Mínimo: 1 Máximo: 32 |
protect_status |
String |
Status de proteção. Seu valor pode ser:
Mínimo: 1 Máximo: 32 |
protect_interrupt |
Boolean |
Se a proteção foi interrompida |
container_tags |
String |
Rótulo, que é usado para identificar o container do CCE e os nós autoconstruídos.
Mínimo: 1 Máximo: 32 |
private_ip |
String |
Endereço IP privado Mínimo: 0 Máximo: 128 |
public_ip |
String |
Endereço IP elástico (EIP) Mínimo: 0 Máximo: 128 |
resource_id |
String |
ID da cota de HSS (UUID) Mínimo: 0 Máximo: 128 |
group_name |
String |
ID do grupo de servidores Mínimo: 1 Máximo: 128 |
enterprise_project_name |
String |
Nome do projeto empresarial Mínimo: 0 Máximo: 256 |
detect_result |
String |
Resultado da verificação do servidor. As opções são as seguintes:
Mínimo: 1 Máximo: 32 |
asset |
Integer |
Riscos de ativos Mínimo: 0 Máximo: 2097152 |
vulnerability |
Integer |
Vulnerabilidades Mínimo: 0 Máximo: 2097152 |
intrusion |
Integer |
Riscos de intrusão Mínimo: 0 Máximo: 2097152 |
policy_group_id |
String |
ID do grupo de políticas Mínimo: 1 Máximo: 128 |
policy_group_name |
String |
Nome do grupo de políticas Mínimo: 1 Máximo: 128 |
Exemplo de solicitações
Essa API é usada para consultar a lista de nós de container. Se o parâmetro limit não for definido, 10 registros serão retornados por padrão.
GET https://{endpoint}/v5/{project_id}/container/nodes
Exemplo de respostas
Código de status: 200
Resposta bem-sucedida
{ "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 amostra do SDK
O código de amostra do SDK é o seguinte.
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) } } |
Mais
Para obter o código de amostra do SDK de mais linguagens de programação, consulte a guia Código de amostra no API Explorer. O código de amostra do SDK pode ser gerado automaticamente.
Códigos de status
Código de status |
Descrição |
---|---|
200 |
Resposta bem-sucedida |
Códigos de erro
Consulte Códigos de erro.