Consulta da lista de servidores de uma conta
Função
Essa API é usada para consultar a lista de servidores de uma conta.
Método de chamada
Para obter detalhes, consulte Chamada de APIs.
URI
GET /v5/{project_id}/asset/users
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto Mínimo: 1 Máximo: 128 |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
host_id |
Não |
String |
ID do host Mínimo: 0 Máximo: 128 |
user_name |
Não |
String |
Nome da conta Mínimo: 0 Máximo: 32 |
host_name |
Não |
String |
Nome do host Mínimo: 0 Máximo: 128 |
private_ip |
Não |
String |
Endereço IP privado de servidor Mínimo: 0 Máximo: 128 |
login_permission |
Não |
Boolean |
Se o logon é permitido. |
root_permission |
Não |
Boolean |
Se o usuário tem permissões de root |
user_group |
Não |
String |
Grupo de usuários do servidor Mínimo: 0 Máximo: 128 |
enterprise_project_id |
Não |
String |
ID do projeto empresarial. Para consultar todos os projetos empresariais, defina este parâmetro como all_granted_eps. Mínimo: 0 Máximo: 128 |
limit |
Não |
Integer |
Número de registros exibidos em cada página. O valor padrão é 10. Mínimo: 10 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. Mínimo: 0 Máximo: 2000000 Padrão: 0 |
category |
Não |
String |
Tipo. O valor padrão é host. As opções são as seguintes:
Mínimo: 0 Máximo: 64 |
part_match |
Não |
Boolean |
Se a correspondência difusa é usada. O valor padrão é false. |
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 |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
total_num |
Integer |
Número total de contas Mínimo: 0 Máximo: 10000 |
data_list |
Array of UserResponseInfo objects |
Lista de informações da conta Comprimento da matriz: 0–10000 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
agent_id |
String |
ID do agente Mínimo: 1 Máximo: 128 |
host_id |
String |
ID do host Mínimo: 1 Máximo: 128 |
host_name |
String |
Nome de servidor Mínimo: 1 Máximo: 128 |
host_ip |
String |
Endereço IP do servidor Mínimo: 1 Máximo: 128 |
user_name |
String |
Nome de usuário Mínimo: 1 Máximo: 128 |
login_permission |
Boolean |
Se o usuário tem a permissão de logon |
root_permission |
Boolean |
Se o usuário tem permissões de root |
user_group_name |
String |
Nome do grupo de usuários Mínimo: 1 Máximo: 128 |
user_home_dir |
String |
Diretório inicial do usuário Mínimo: 1 Máximo: 256 |
shell |
String |
Shell de inicialização do usuário Mínimo: 1 Máximo: 128 |
recent_scan_time |
Long |
Hora da última verificação Mínimo: 0 Máximo: 4070880000000 |
container_id |
String |
ID do container Mínimo: 1 Máximo: 128 |
container_name |
String |
Nome do container Mínimo: 1 Máximo: 256 |
Exemplo de solicitações
Consultar a lista de servidores cuja conta é daemon por padrão.
GET https://{endpoint}/v5/{project_id}/asset/users?user_name=daemon
Exemplo de respostas
Código de status: 200
Lista de informações da conta
{ "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 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 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) } } |
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 |
Lista de informações da conta |
Códigos de erro
Consulte Códigos de erro.