Consulta de la lista de servidores del software
Función
Esta API se utiliza para consultar la lista de servidores del software.
Método de invocación
Para obtener más información, consulte Invocación a las API.
URI
GET /v5/{project_id}/asset/apps
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID de proyecto Mínimo: 1 Máximo: 256 |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
host_id |
Sí |
String |
ID del servidor Mínimo: 0 Máximo: 128 |
host_name |
No |
String |
Nombre del servidor Mínimo: 0 Máximo: 128 |
app_name |
No |
String |
Nombre del software Mínimo: 0 Máximo: 128 |
host_ip |
No |
String |
Dirección IP de servidor Mínimo: 0 Máximo: 128 |
version |
No |
String |
Versión de software Mínimo: 0 Máximo: 128 |
install_dir |
No |
String |
Directorio de instalación Mínimo: 0 Máximo: 512 |
enterprise_project_id |
No |
String |
ID de proyecto empresarial. Para consultar todos los proyectos empresariales, establezca este parámetro en all_granted_eps. Mínimo: 1 Máximo: 256 |
limit |
No |
Integer |
Número de registros mostrados en cada página. El valor predeterminado es 10. Mínimo: 10 Máximo: 100 Valor predeterminado: 10 |
offset |
No |
Integer |
Desfase, que especifica la posición inicial del registro que se va a devolver. El valor debe ser un número. Mínimo: 0 Máximo: 10000 Valor predeterminado: 0 |
category |
No |
String |
Tipo. El valor predeterminado es host. Las opciones son las siguientes:
Mínimo: 0 Máximo: 64 |
part_match |
No |
Boolean |
Si se utiliza una coincidencia difusa. El valor predeterminado es false. |
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 de usuario. Mínimo: 32 Máximo: 4096 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total_num |
Integer |
Total de software Mínimo: 0 Máximo: 10000 |
data_list |
Array of AppResponseInfo objects |
Lista de software Longitud de matriz: 0 - 10000 |
Parámetro |
Tipo |
Descripción |
---|---|---|
agent_id |
String |
ID del agente del HSS Mínimo: 0 Máximo: 128 |
host_id |
String |
ID del servidor Mínimo: 1 Máximo: 128 |
host_name |
String |
Nombre del servidor Mínimo: 1 Máximo: 256 |
host_ip |
String |
Dirección IP de servidor Mínimo: 1 Máximo: 256 |
app_name |
String |
Nombre del software Mínimo: 1 Máximo: 128 |
version |
String |
Número de versión Mínimo: 1 Máximo: 128 |
update_time |
Long |
Hora de la última actualización, en milisegundos. Mínimo: 0 Máximo: 2147483647 |
recent_scan_time |
Long |
Tiempo de escaneo más reciente, en milisegundos. Mínimo: 0 Máximo: 2147483647 |
container_id |
String |
ID de contenedor Mínimo: 1 Máximo: 128 |
container_name |
String |
Nombre de contenedor Mínimo: 1 Máximo: 256 |
Solicitudes de ejemplo
Los primeros 10 servidores cuyo nombre de software es ACL se consultan de forma predeterminada.
GET https://{endpoint}/v5/{project_id}/asset/apps?app_name=acl
Ejemplo de respuestas
Código de estado: 200
Aplicaciones instaladas en un host
{ "total_num" : 1, "data_list" : [ { "agent_id" : "c9bed5397db449ebdfba15e85fcfc36accee125c68954daf5cab0528bab59bd8", "host_id" : "55dac7fe-d81b-43bc-a4a7-4710fe673972", "host_name" : "xxxx", "host_ip" : "192.168.0.126", "app_name" : "acl", "version" : "2.2.51-14.eulerosv2r7", "update_time" : 1668150671981, "recent_scan_time" : 1668506044147, "container_id" : "ce794b8a6071f5fd7e4d142dab7b36bedf2c7a4f6083fb82e5bbc82709b50018", "container_name" : "hss_imagescan_W73V1WO6" } ] }
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 53 54 55 56 |
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 ListAppsSolution { 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(); ListAppsRequest request = new ListAppsRequest(); request.withHostId("<host_id>"); request.withHostName("<host_name>"); request.withAppName("<app_name>"); request.withHostIp("<host_ip>"); request.withVersion("<version>"); request.withInstallDir("<install_dir>"); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withCategory("<category>"); request.withPartMatch(<part_match>); try { ListAppsResponse response = client.listApps(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 37 38 39 40 |
# 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 = ListAppsRequest() request.host_id = "<host_id>" request.host_name = "<host_name>" request.app_name = "<app_name>" request.host_ip = "<host_ip>" request.version = "<version>" request.install_dir = "<install_dir>" request.enterprise_project_id = "<enterprise_project_id>" request.limit = <limit> request.offset = <offset> request.category = "<category>" request.part_match = <PartMatch> response = client.list_apps(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 50 51 52 53 54 55 56 |
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.ListAppsRequest{} request.HostId = "<host_id>" hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest appNameRequest:= "<app_name>" request.AppName = &appNameRequest hostIpRequest:= "<host_ip>" request.HostIp = &hostIpRequest versionRequest:= "<version>" request.Version = &versionRequest installDirRequest:= "<install_dir>" request.InstallDir = &installDirRequest enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest categoryRequest:= "<category>" request.Category = &categoryRequest partMatchRequest:= <part_match> request.PartMatch = &partMatchRequest response, err := client.ListApps(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 |
Aplicaciones instaladas en un host |
Códigos de error
Consulte Códigos de error.