文档首页/ 云防火墙 CFW/ API参考/ API/ 抓包管理/ 批量删除抓包任务
更新时间:2024-10-31 GMT+08:00
分享

批量删除抓包任务

功能介绍

批量删除抓包任务

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/capture-task/batch-delete

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙id,可通过防火墙ID获取方式获取

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

表4 请求Body参数

参数

是否必选

参数类型

描述

task_ids

Array of strings

抓包任务id列表,抓包任务id可通过查询抓包任务接口查询获得,通过返回值中的data.records.task_id(.表示各对象之间层级的区分)获得。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

data

CaptureTaskId object

删除抓包任务返回数据

表6 CaptureTaskId

参数

参数类型

描述

id

String

防火墙id

name

String

防火墙名称

请求示例

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4删除抓包任务,抓包任务id为24e6bb6d-d335-48fd-b9c7-bbaaa851d209.

https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/batch-delete?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default

{
  "task_ids" : [ "24e6bb6d-d335-48fd-b9c7-bbaaa851d209" ]
}

响应示例

状态码: 200

删除抓包任务返回值

{
  "data" : {
    "id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4",
    "name" : "test"
  }
}

SDK代码示例

SDK代码示例如下。

Java

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4删除抓包任务,抓包任务id为24e6bb6d-d335-48fd-b9c7-bbaaa851d209.

 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
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.cfw.v1.region.CfwRegion;
import com.huaweicloud.sdk.cfw.v1.*;
import com.huaweicloud.sdk.cfw.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class DeleteCaptureTaskSolution {

    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);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        DeleteCaptureTaskRequest request = new DeleteCaptureTaskRequest();
        DeleteCaptureTaskDto body = new DeleteCaptureTaskDto();
        List<String> listbodyTaskIds = new ArrayList<>();
        listbodyTaskIds.add("24e6bb6d-d335-48fd-b9c7-bbaaa851d209");
        body.withTaskIds(listbodyTaskIds);
        request.withBody(body);
        try {
            DeleteCaptureTaskResponse response = client.deleteCaptureTask(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

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4删除抓包任务,抓包任务id为24e6bb6d-d335-48fd-b9c7-bbaaa851d209.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcfw.v1 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 = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DeleteCaptureTaskRequest()
        listTaskIdsbody = [
            "24e6bb6d-d335-48fd-b9c7-bbaaa851d209"
        ]
        request.body = DeleteCaptureTaskDto(
            task_ids=listTaskIdsbody
        )
        response = client.delete_capture_task(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

向项目id为09bb24e6fe80d23d2fa2c010b53b418c,防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4删除抓包任务,抓包任务id为24e6bb6d-d335-48fd-b9c7-bbaaa851d209.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/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 := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DeleteCaptureTaskRequest{}
	var listTaskIdsbody = []string{
        "24e6bb6d-d335-48fd-b9c7-bbaaa851d209",
    }
	request.Body = &model.DeleteCaptureTaskDto{
		TaskIds: listTaskIdsbody,
	}
	response, err := client.DeleteCaptureTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

删除抓包任务返回值

错误码

请参见错误码

相关文档