获取日志配置
功能介绍
获取日志配置
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/cfw/logs/configuration
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
fw_instance_id |
是 |
String |
防火墙id,可通过防火墙ID获取方式获取 |
enterprise_project_id |
否 |
String |
企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。可通过如何获取用户Token获取。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
LogConfigDto object |
日志配置数据 |
参数 |
参数类型 |
描述 |
---|---|---|
fw_instance_id |
String |
防火墙id,可通过防火墙ID获取方式获取 |
lts_enable |
Integer |
是否开启LTS,1表示是,0表示不是 |
lts_log_group_id |
String |
LTS日志分组id,可通过查询LTS(云日志服务)下查询账号下所有日志组接口获得,通过返回值中的log_groups.log_group_id(.表示各对象之间层级的区分)获得 |
lts_attack_log_stream_id |
String |
攻击日志流id,可通过查询LTS(云日志服务)下查询指定日志组下的所有日志流接口获得,通过返回值中的log_streams.log_stream_id(.表示各对象之间层级的区分)获得 |
lts_attack_log_stream_enable |
Integer |
是否开启攻击日志流,1表示是,0表示不是 |
lts_access_log_stream_id |
String |
访问控制日志流id,可通过查询LTS(云日志服务)下查询指定日志组下的所有日志流接口获得,通过返回值中的log_streams.log_stream_id(.表示各对象之间层级的区分)获得 |
lts_access_log_stream_enable |
Integer |
是否开启访问控制流,1表示是,0表示不是 |
lts_flow_log_stream_id |
String |
流量日志id,可通过查询LTS(云日志服务)下查询指定日志组下的所有日志流接口获得,通过返回值中的log_streams.log_stream_id(.表示各对象之间层级的区分)获得 |
lts_flow_log_stream_enable |
Integer |
是否开启流量日志,1表示是,0表示不是 |
请求示例
查询项目id为408972e72dcd4c1a9b033e955802a36b下的防火墙id为4e113415-7811-4bb3-bf5e-eb835953f7d4的防火墙的日志配置。
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default
响应示例
状态码: 200
查询日志配置返回值
{ "data" : { "fw_instance_id" : "4df2bcd1-6299-4fba-8e71-8d50ea807090", "lts_access_log_stream_enable" : 0, "lts_attack_log_stream_enable" : 0, "lts_enable" : 0, "lts_flow_log_stream_enable" : 0, "lts_log_group_id" : "d783ce42-7f56-4c2d-9a96-b1043d016f5a" } }
SDK代码示例
SDK代码示例如下。
Java
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.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListLogConfigSolution { 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(); ListLogConfigRequest request = new ListLogConfigRequest(); try { ListLogConfigResponse response = client.listLogConfig(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
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 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 = ListLogConfigRequest() response = client.list_log_config(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
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" 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.ListLogConfigRequest{} response, err := client.ListLogConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询日志配置返回值 |
错误码
请参见错误码。