查询软件的服务器列表
功能介绍
查询软件的服务器列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/asset/apps
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
host_id |
是 |
String |
主机id 最小长度:0 最大长度:128 |
host_name |
否 |
String |
主机名称 最小长度:0 最大长度:128 |
app_name |
否 |
String |
软件名称 最小长度:0 最大长度:128 |
host_ip |
否 |
String |
主机ip 最小长度:0 最大长度:128 |
version |
否 |
String |
软件版本号 最小长度:0 最大长度:128 |
install_dir |
否 |
String |
安装目录 最小长度:0 最大长度:512 |
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 最小长度:1 最大长度:256 |
limit |
否 |
Integer |
每页显示数量 最小值:10 最大值:100 缺省值:10 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 最小值:0 最大值:10000 缺省值:0 |
category |
否 |
String |
类别,默认为host,包含如下:
最小长度:0 最大长度:64 |
part_match |
否 |
Boolean |
是否模糊匹配,默认false表示精确匹配 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:32 最大长度:4096 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
软件总数 最小值:0 最大值:10000 |
data_list |
Array of AppResponseInfo objects |
软件列表 数组长度:0 - 10000 |
参数 |
参数类型 |
描述 |
---|---|---|
agent_id |
String |
Agent ID 最小长度:0 最大长度:128 |
host_id |
String |
主机id 最小长度:1 最大长度:128 |
host_name |
String |
服务器名称 最小长度:1 最大长度:256 |
host_ip |
String |
服务器ip 最小长度:1 最大长度:256 |
app_name |
String |
软件名称 最小长度:1 最大长度:128 |
version |
String |
版本号 最小长度:1 最大长度:128 |
update_time |
Long |
更新时间,最近一次更新的时间,用毫秒表示 最小值:0 最大值:2147483647 |
recent_scan_time |
Long |
最近扫描时间,用毫秒表示 最小值:0 最大值:2147483647 |
container_id |
String |
容器id 最小长度:1 最大长度:128 |
container_name |
String |
容器名称 最小长度:1 最大长度:256 |
请求示例
默认查询前10条软件名称为acl的服务器列表
GET https://{endpoint}/v5/{project_id}/asset/apps?app_name=acl
响应示例
状态码: 200
单台主机安装的app
{ "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" } ] }
SDK代码示例
SDK代码示例如下。
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()); } } } |
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 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["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) |
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
单台主机安装的app |
错误码
请参见错误码。