Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Actualización más reciente 2025-04-08 GMT+08:00

Consulta de la lista de servidores de una cuenta

Función

Esta API se utiliza para consultar la lista de servidores de una cuenta.

Método de invocación

Para obtener más información, consulte Invocación a las API.

URI

GET /v5/{project_id}/asset/users

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID de proyecto

Mínimo: 1

Máximo: 128

Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

host_id

No

String

ID de host

Mínimo: 0

Máximo: 128

user_name

No

String

Nombre de cuenta

Mínimo: 0

Máximo: 32

host_name

No

String

Nombre de host

Mínimo: 0

Máximo: 128

private_ip

No

String

Dirección IP privada del servidor

Mínimo: 0

Máximo: 128

login_permission

No

Boolean

Si se permite el inicio de sesión.

root_permission

No

Boolean

Si el usuario tiene permisos raíz

user_group

No

String

Grupo de usuario de servidor

Mínimo: 0

Máximo: 128

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: 0

Máximo: 128

limit

No

Integer

Número de registros mostrados en cada página. El valor predeterminado es 10.

Mínimo: 10

Máximo: 200

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: 2000000

Valor predeterminado: 0

category

No

String

Tipo. El valor predeterminado es host. Las opciones son las siguientes:

  • host

  • container

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

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

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

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

total_num

Integer

Número total de cuentas

Mínimo: 0

Máximo: 10000

data_list

Array of UserResponseInfo objects

Lista de información de cuenta

Longitud de matriz: 0 - 10000

Tabla 5 UserResponseInfo

Parámetro

Tipo

Descripción

agent_id

String

ID de agente

Mínimo: 1

Máximo: 128

host_id

String

ID de host

Mínimo: 1

Máximo: 128

host_name

String

Nombre del servidor

Mínimo: 1

Máximo: 128

host_ip

String

Dirección IP de servidor

Mínimo: 1

Máximo: 128

user_name

String

Nombre de usuario

Mínimo: 1

Máximo: 128

login_permission

Boolean

Si el usuario tiene permiso de inicio de sesión

root_permission

Boolean

Si el usuario tiene permisos raíz

user_group_name

String

Nombre de grupo de usuarios

Mínimo: 1

Máximo: 128

user_home_dir

String

Directorio principal del usuario

Mínimo: 1

Máximo: 256

shell

String

Shell de inicio de usuario

Mínimo: 1

Máximo: 128

recent_scan_time

Long

Hora de escaneo más reciente

Mínimo: 0

Máximo: 4070880000000

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

Consultar lista de servidores cuya cuenta es daemon por defecto.

GET https://{endpoint}/v5/{project_id}/asset/users?user_name=daemon

Ejemplo de respuestas

Código de estado: 200

Lista de información de cuenta

{
  "total_num" : 1,
  "data_list" : [ {
    "agent_id" : "0bf792d910xxxxxxxxxxx52cb7e63exxx",
    "host_id" : "13xxxxxxxece69",
    "host_ip" : "192.168.0.1",
    "host_name" : "test",
    "login_permission" : false,
    "recent_scan_time" : 1667039707730,
    "root_permission" : false,
    "shell" : "/sbin/nologin",
    "user_group_name" : "bin",
    "user_home_dir" : "/bin",
    "user_name" : "bin",
    "container_id" : "ce794b8a6-xxxx-xxxx-xxxxx-36bedf2c7a4f6083fb82e5bbc82709b50018",
    "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
57
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 ListUsersSolution {

    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();
        ListUsersRequest request = new ListUsersRequest();
        request.withHostId("<host_id>");
        request.withUserName("<user_name>");
        request.withHostName("<host_name>");
        request.withPrivateIp("<private_ip>");
        request.withLoginPermission(<login_permission>);
        request.withRootPermission(<root_permission>);
        request.withUserGroup("<user_group>");
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withCategory("<category>");
        request.withPartMatch(<part_match>);
        try {
            ListUsersResponse response = client.listUsers(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
41
# 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 = ListUsersRequest()
        request.host_id = "<host_id>"
        request.user_name = "<user_name>"
        request.host_name = "<host_name>"
        request.private_ip = "<private_ip>"
        request.login_permission = <LoginPermission>
        request.root_permission = <RootPermission>
        request.user_group = "<user_group>"
        request.enterprise_project_id = "<enterprise_project_id>"
        request.limit = <limit>
        request.offset = <offset>
        request.category = "<category>"
        request.part_match = <PartMatch>
        response = client.list_users(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
57
58
59
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.ListUsersRequest{}
	hostIdRequest:= "<host_id>"
	request.HostId = &hostIdRequest
	userNameRequest:= "<user_name>"
	request.UserName = &userNameRequest
	hostNameRequest:= "<host_name>"
	request.HostName = &hostNameRequest
	privateIpRequest:= "<private_ip>"
	request.PrivateIp = &privateIpRequest
	loginPermissionRequest:= <login_permission>
	request.LoginPermission = &loginPermissionRequest
	rootPermissionRequest:= <root_permission>
	request.RootPermission = &rootPermissionRequest
	userGroupRequest:= "<user_group>"
	request.UserGroup = &userGroupRequest
	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.ListUsers(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

Lista de información de cuenta

Códigos de error

Consulte Códigos de error.