Querying the Server List of a Specified Middleware
Function
This API is used to query the server list of a specified middleware. You can query the middleware server list by its middleware name.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/asset/midwares/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
file_name |
Yes |
String |
Definition File name. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
category |
No |
String |
Definition Type. Constraints N/A Range
Default Value N/A |
host_name |
No |
String |
Definition Server name. Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A |
host_ip |
No |
String |
Definition Server IP address. Constraints N/A Range The value can contain 0 to 64 characters. Default Value N/A |
limit |
No |
Integer |
Parameter description: Number of records displayed on each page. Constraints: N/A Options: Value range: 10-200 Default value: 10 |
offset |
No |
Integer |
Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0. |
part_match |
No |
Boolean |
Definition Whether fuzzy match is used. Constraints N/A Range
Default Value false |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Details: Total number of servers containing the middleware Options: The value contains 0 to 10,000 characters. |
data_list |
Array of JarPackageHostInfo objects |
Definition Server list. Range N/A |
Parameter |
Type |
Description |
---|---|---|
agent_id |
String |
Details: agent_id Options: The value contains 1 to 64 characters. |
host_id |
String |
Details: Host ID. Options: The value contains 0 to 128 characters. |
host_name |
String |
Details: Server name Options: The value contains 0 to 256 characters. |
host_ip |
String |
Details: Server IP address Options: The value contains 0 to 128 characters. |
file_name |
String |
Details: Middleware package name Options: The value contains 0 to 256 characters. |
name |
String |
Details: Middleware package name (without the file name extension) Options: The value contains 0 to 256 characters. |
catalogue |
String |
Details: Middleware package type Options: The value contains 0 to 32 characters. |
file_type |
String |
Details: Middleware package suffix Options: The value contains 0 to 32 characters. |
version |
String |
Details: Middleware package version Options: The value contains 0 to 64 characters. |
path |
String |
Details: Middleware package path Options: The value contains 0 to 512 characters. |
hash |
String |
Details: Middleware package hash Options: The value contains 0 to 512 characters. |
size |
Integer |
Details: Middleware package size Options: The value ranges from 0 to 2147483647. |
uid |
Integer |
Details: uid Options: The value ranges from 0 to 2147483647. |
gid |
Integer |
Details: gid Options: The value ranges from 0 to 2147483647. |
mode |
String |
Details: File Permissions Options: The value contains 0 to 32 characters. |
pid |
Integer |
Details: Process ID. Options: The value ranges from 0 to 2147483647. |
proc_path |
String |
Details: Path of the executable file of a process Options: The value contains 0 to 1024 characters. |
container_id |
String |
Details: Container instance ID Options: The value contains 0 to 128 characters. |
container_name |
String |
Details: Container Name Options: The value contains 0 to 256 characters. |
package_path |
String |
Details: Package path Options: The value contains 0 to 1024 characters. |
is_embedded |
Integer |
Details: Nested Package Options:
|
record_time |
Long |
Details: Scanned On Options: The value ranges from 0 to 4070880000000. |
Example Requests
The first 10 servers whose middleware name is log4j-core-2.8.2.jar and type is host are queried by default.
GET https://{endpoint}/v5/{project_id}/asset/midwares/detail?file_name=log4j-core-2.8.2.jar&category=host
Example Responses
Status code: 200
Request succeeded.
{ "data_list" : [ { "agent_id" : "2d0fe7824005bf001220ad9d892e86f8af44a7d3608dab11165008ce439d3583", "catalogue" : "util", "container_id" : "", "file_name" : "rt.jar", "file_type" : "jar", "gid" : 0, "hash" : "04bf14e3b1da55d95561ca78cb29caa909410051dbe047e91ad6f5c1dedb8d6d", "host_id" : "103ed820-62e5-4754-b0f8-3e47b6dd49d2", "host_ip" : "192.168.1.76", "host_name" : "Do not delete the test.", "mode" : "-rw-------", "name" : "Java Runtime Environment", "path" : "/CloudResetPwdUpdateAgent/depend/jre/lib/rt.jar", "pid" : 1614, "proc_path" : "/CloudResetPwdUpdateAgent/depend/jre/bin/java", "record_time" : 1690513169986, "uid" : 0, "version" : "1.8.0_252", "size" : 128, "container_name" : "aaaa", "package_path" : "/CloudResetPwdUpdateAgent/depend/jre/bin/java", "is_embedded" : 0 } ], "total_num" : 1 }
SDK Sample Code
The SDK sample code is as follows.
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 |
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 ListJarPackageHostInfoSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListJarPackageHostInfoRequest request = new ListJarPackageHostInfoRequest(); try { ListJarPackageHostInfoResponse response = client.listJarPackageHostInfo(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 |
# 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListJarPackageHostInfoRequest() response = client.list_jar_package_host_info(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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListJarPackageHostInfoRequest{} response, err := client.ListJarPackageHostInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot