Exporting the List of Protected WTP Directories
Function
This API is used to export the list of protected WTP directories.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/webtamper/host/export
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. |
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_id |
No |
String |
Definition Host ID. Range Length: 1 to 64 characters |
host_id_list |
No |
Array of strings |
Definition Server ID list. Range N/A |
host_name |
No |
String |
Definition Server name. Range The value can contain 1 to 256 characters. |
public_ip |
No |
String |
Definition EIP. Range The value can contain 1 to 256 characters. |
private_ip |
No |
String |
Definition Server private IP address. Range The value can contain 1 to 128 characters. |
agent_id |
No |
String |
Definition Agent ID. (This parameter has been discarded. Use host_id instead.) Constraints N/A Range Length: 1 to 64 characters Default Value N/A |
os_type |
No |
String |
Definition OS type. Range
|
asset_value |
No |
String |
Asset importance. Its value can be:
|
group_name |
No |
String |
Definition Server group name. Range The value can contain 0 to 256 characters. |
protect_status |
No |
String |
Protection status. (This parameter has been discarded. Use wtp_status instead.) |
agent_status |
No |
String |
Definition Agent status. Constraints N/A Range
Default Value N/A |
rasp_protect_status |
No |
String |
Dynamic Web Tamper Protection Status
|
wtp_status |
No |
String |
Definition WTP status. Range
|
offset |
No |
Integer |
Offset. (This parameter has been discarded. Use export_size instead.) |
limit |
No |
Integer |
Number of records displayed on each page. (This parameter has been discarded. Use export_size instead.) |
export_headers |
Yes |
Array<Array<String>> |
Definition Export data table header details. Constraints The table header information must be in the following format: [[Field1,ColumnHeader1],[Field2,ColumnHeader2],[Field3,ColumnHeader3]] Range You can select some or all of the following values to form the table header information:
Default Value N/A |
export_size |
Yes |
Integer |
Definition Maximum number of exported data records. Constraints N/A Range Minimum value: 1; maximum value: 200000 Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Definition ID of the export task. Range Length: 0 to 128 characters |
Example Requests
Export the list of directories protected by WTP.
POST https://{endpoint}/v5/{project_id}/webtamper/host/export { "export_size" : 10, "export_headers" : [ [ "host_name", "Server name" ], [ "host_id", "Server ID." ] ] }
Example Responses
Status code: 200
Request succeeded.
{ "task_id" : "9e8***4-d26b-426d-a2be-765930242984" }
SDK Sample Code
The SDK sample code is as follows.
Export the list of directories protected by WTP.
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 60 61 62 |
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.*; import java.util.List; import java.util.ArrayList; public class ExportWebTamperHostSolution { 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(); ExportWebTamperHostRequest request = new ExportWebTamperHostRequest(); ExportWebTamperHostRequestInfo body = new ExportWebTamperHostRequestInfo(); List<String> listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("host_id"); listExportHeadersExportHeaders.add("Server ID."); List<String> listExportHeadersExportHeaders1 = new ArrayList<>(); listExportHeadersExportHeaders1.add("host_name"); listExportHeadersExportHeaders1.add("Server name"); List<List<String>> listbodyExportHeaders = new ArrayList<>(); listbodyExportHeaders.add(listExportHeadersExportHeaders); listbodyExportHeaders.add(listExportHeadersExportHeaders1); body.withExportSize(10); body.withExportHeaders(listbodyExportHeaders); request.withBody(body); try { ExportWebTamperHostResponse response = client.exportWebTamperHost(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()); } } } |
Export the list of directories protected by WTP.
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 |
# 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 = ExportWebTamperHostRequest() listExportHeadersExportHeaders = [ "host_id", "Server ID." ] listExportHeadersExportHeaders1 = [ "host_name", "Server name" ] listExportHeadersbody = [ listExportHeadersExportHeaders, listExportHeadersExportHeaders1 ] request.body = ExportWebTamperHostRequestInfo( export_size=10, export_headers=listExportHeadersbody ) response = client.export_web_tamper_host(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Export the list of directories protected by WTP.
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 |
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.ExportWebTamperHostRequest{} var listExportHeadersExportHeaders = []string{ "host_id", "Server ID.", } var listExportHeadersExportHeaders1 = []string{ "host_name", "Server name", } var listExportHeadersbody = [][]string{ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, } request.Body = &model.ExportWebTamperHostRequestInfo{ ExportSize: int32(10), ExportHeaders: listExportHeadersbody, } response, err := client.ExportWebTamperHost(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