Consulta da lista de servidores correspondentes a uma tarefa de verificação de vulnerabilidade
Função
Essa API é usada para consultar a lista de servidores correspondentes a uma tarefa de verificação de vulnerabilidade.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v5/{project_id}/vulnerability/scan-task/{task_id}/hosts
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto do locatário Mínimo: 1 Máximo: 256 |
task_id |
Sim |
String |
ID da tarefa 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: 0 Máximo: 256 |
limit |
Não |
Integer |
Número de registros exibidos em cada página. Mínimo: 0 Máximo: 200 Padrão: 10 |
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 |
scan_status |
Não |
String |
Status de verificação do servidor. As opções são as seguintes:
Mínimo: 0 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 uma API do IAM. O valor de X-Subject-Token no cabeçalho de resposta é o token do usuário. Mínimo: 1 Máximo: 32768 |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
total_num |
Long |
Número total Mínimo: 0 Máximo: 2147483647 |
data_list |
Array of VulScanTaskHostInfo objects |
Indica a lista de servidores correspondentes a uma tarefa de verificação de vulnerabilidades. Comprimento da matriz: 0–2147483647 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
host_id |
String |
ID de servidor Mínimo: 1 Máximo: 128 |
host_name |
String |
Nome de servidor Mínimo: 0 Máximo: 128 |
public_ip |
String |
EIP Mínimo: 0 Máximo: 128 |
private_ip |
String |
Endereço IP privado Mínimo: 0 Máximo: 128 |
asset_value |
String |
Importância de ativo. As opções são as seguintes:
Mínimo: 0 Máximo: 128 |
scan_status |
String |
Status de verificação do servidor. As opções são as seguintes: -scanning -success -failed Mínimo: 0 Máximo: 32 |
failed_reasons |
Array of failed_reasons objects |
Lista de causas de falha de verificação Comprimento da matriz: 0–2147483647 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
vul_type |
String |
Tipo da vulnerabilidade que não foi verificada. As opções são as seguintes: -linux_vul: vulnerabilidade do Linux -windows_vul: vulnerabilidade do Windows -web_cms: vulnerabilidade de Web-CMS -app_vul: vulnerabilidade de aplicação Mínimo: 1 Máximo: 32 |
failed_reason |
String |
Causa da falha de verificação. Mínimo: 0 Máximo: 128 |
Exemplo de solicitações
Essa API é usada para consultar detalhes da tarefa de verificação de vulnerabilidade cujo ID é 2b31ed520xxxxxxebedb6e57xxxxxxxx. A lista de servidores e causas de falha é exibida. Por padrão, 10 servidores na primeira página são consultados.
GET https://{endpoint}/v5/{project_id}/vulnerability/scan-task/{task_id}/hosts?offset=0&limit=10&scan_status=failed&enterprise_project_id=XXX { "scan_status" : "failed", "task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx" }
Exemplo de respostas
Código de status: 200
Indica a lista de servidores correspondentes a uma tarefa de verificação de vulnerabilidades.
{ "total_num" : 1, "data_list" : [ { "host_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "host_name" : "ecs-ubuntu-abc123", "public_ip" : "112.10.10.3", "private_ip" : "192.168.10.1", "asset_value" : "important", "scan_status" : "failed", "failed_reasons" : [ { "vul_type" : "linux_vul", "failed_reason" : "this_is_failed_reason" } ] } ] }
Código de amostra do SDK
O código de amostra do SDK é o seguinte.
Java
Essa API é usada para consultar detalhes da tarefa de verificação de vulnerabilidade cujo ID é 2b31ed520xxxxxxebedb6e57xxxxxxxx. A lista de servidores e causas de falha é exibida. Por padrão, 10 servidores na primeira página são consultados.
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 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 ListVulScanTaskHostSolution { 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(); ListVulScanTaskHostRequest request = new ListVulScanTaskHostRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withScanStatus("<scan_status>"); try { ListVulScanTaskHostResponse response = client.listVulScanTaskHost(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
Essa API é usada para consultar detalhes da tarefa de verificação de vulnerabilidade cujo ID é 2b31ed520xxxxxxebedb6e57xxxxxxxx. A lista de servidores e causas de falha é exibida. Por padrão, 10 servidores na primeira página são consultados.
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 |
# 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 = ListVulScanTaskHostRequest() request.enterprise_project_id = "<enterprise_project_id>" request.limit = <limit> request.offset = <offset> request.scan_status = "<scan_status>" response = client.list_vul_scan_task_host(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
Essa API é usada para consultar detalhes da tarefa de verificação de vulnerabilidade cujo ID é 2b31ed520xxxxxxebedb6e57xxxxxxxx. A lista de servidores e causas de falha é exibida. Por padrão, 10 servidores na primeira página são consultados.
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 |
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.ListVulScanTaskHostRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest scanStatusRequest:= "<scan_status>" request.ScanStatus = &scanStatusRequest response, err := client.ListVulScanTaskHost(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 |
Indica a lista de servidores correspondentes a uma tarefa de verificação de vulnerabilidades. |
Códigos de erro
Consulte Códigos de erro.