文档首页/ 云防火墙 CFW/ API参考/ API/ 防火墙管理/ 获取CFW任务执行状态
更新时间:2025-08-12 GMT+08:00

获取CFW任务执行状态

功能介绍

获取CFW任务执行状态

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

job_id

String

参数解释

创建按需防火墙返回的任务ID,可通过调用创建防火墙接口返回值获得。返回值中job_id即为此处的job_id

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token,用于携带用户身份信息,配置后可通过接口鉴权,可通过如何获取用户Token获取。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

GetCreateFirewallJobResponseData object

参数解释

创建按需防火墙返回数据。

取值范围

不涉及

表4 GetCreateFirewallJobResponseData

参数

参数类型

描述

id

String

参数解释

创建按需防火墙任务ID

取值范围

不涉及

status

String

参数解释

任务执行状态,用于展示创建防火墙是否成功。

取值范围

  • Running:表示任务正在执行。

  • Success:表示任务执行成功。

  • Failed:表示任务执行失败。

begin_time

String

参数解释

创建时间

取值范围

格式为“yyyy-mm-ddThh:mm:ssZ”,其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

例如:

  • 2023-10-26T10:30:00Z 表示: 2023年10月26日10点30分00秒,UTC时间

  • 2023-10-26T10:30:00+0800 表示: 2023年10月26日10点30分00秒,比UTC时间快8小时,也就是北京时间。

end_time

String

参数解释

结束时间

取值范围

格式为“yyyy-mm-ddThh:mm:ssZ”,其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

例如:

  • 2023-10-26T10:30:00Z 表示: 2023年10月26日10点30分00秒,UTC时间

  • 2023-10-26T10:30:00+0800 表示: 2023年10月26日10点30分00秒,比UTC时间快8小时,也就是北京时间。

请求示例

获取项目09bb24e6fe80d23d2fa2c010b53b418c下的创建按需防火墙的job ID为的f588ce71-e26c-400d-8981-f854355f6849的任务情况。

https://{Endpoint}/v3/09bb24e6fe80d23d2fa2c010b53b418c/jobs/f588ce71-e26c-400d-8981-f854355f6849

响应示例

状态码:200

OK,获取创建按需防火墙任务情况接口返回值

{
  "data" : {
    "begin_time" : 1641370501000,
    "end_time" : 1641370515000,
    "id" : "f588ce71-e26c-400d-8981-f854355f6849",
    "status" : "Success"
  }
}

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
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.*;


public class ListJobSolution {

    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();
        ListJobRequest request = new ListJobRequest();
        request.withJobId("{job_id}");
        try {
            ListJobResponse response = client.listJob(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
# 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 = ListJobRequest()
        request.job_id = "{job_id}"
        response = client.list_job(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
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.ListJobRequest{}
	request.JobId = "{job_id}"
	response, err := client.ListJob(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK,获取创建按需防火墙任务情况接口返回值

错误码

请参见错误码