更新时间:2024-12-11 GMT+08:00
分享

查询用户操作日志信息

功能介绍

查询用户操作日志信息

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/{instance_id}/dbss/audit/operate-log

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

instance_id

String

实例ID。可在查询实例列表接口的ID字段获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

time

TimeRangeBean object

查询时间范围

user_name

String

操作日志用户名

action

String

动作名称

  • CREATE
  • DELETE
  • DOWNLOAD
  • UPDATE

result

String

执行结果

  • success
  • fail

page

String

页数

size

String

每页条数

表4 TimeRangeBean

参数

是否必选

参数类型

描述

end_time

String

开始时间,必须和end_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间

start_time

String

结束时间,必须和start_time成对出现。格式必须为yyyy-MM-dd HH:mm:ss。UTC时间

time_range

String

请求查询的时间段,和start_time,end_time不能同时使用,同时传该参数优先级更高。

  • HALF_HOUR
  • HOUR
  • THREE_HOUR
  • TWELVE_HOUR
  • DAY
  • WEEK
  • MONTH

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

operate_log

Array of OperateLogInfo objects

操作日志列表

表6 OperateLogInfo

参数

参数类型

描述

id

String

操作日志ID

user

String

操作日志用户名

time

String

该条记录发生的时间,格式为时间戳。

action

String

该条记录的操作类型

  • create:创建
  • update:更新
  • delete:删除
  • download: 下载

function

String

该条记录的功能类型

name

String

该条记录对应的用户操作对象

description

String

该条记录具体的描述

result

String

该条记录对应用户执行的结果

  • success: 成功
  • fail: 失败

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表8 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码: 403

表9 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表10 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

状态码: 500

表11 响应Body参数

参数

参数类型

描述

error

Object

错误信息返回体。

表12 ErrorDetail

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

error_msg

String

错误请求返回的错误信息。

请求示例

/v1/{project_id}/{instance_id}/dbss/audit/operate-log

{
  "time" : {
    "time_range" : "HOUR"
  },
  "page" : 1,
  "size" : 10
}

响应示例

状态码: 200

成功

{
  "total_num" : 3,
  "operate_log" : [ {
    "id" : "1LJP-HgBCwCqSg3BVuAp",
    "user" : "hby-test",
    "time" : "2021-04-22 06:40:52",
    "function" : "数据库列表",
    "action" : "删除",
    "name" : "db01 ",
    "description" : "删除审计的数据库",
    "result" : "success"
  }, {
    "id" : "07JO-HgBCwCqSg3ByOAD",
    "user" : "hby-test",
    "time" : "2021-04-22 06:40:15",
    "function" : "数据库列表",
    "action" : "更新",
    "name" : "db01 ",
    "description" : "关闭审计客户端",
    "result" : "success"
  }, {
    "id" : "ULKM93gBCwCqSg3BZeD1",
    "user" : "hby-test",
    "time" : "2021-04-22 03:07:56",
    "function" : "数据库列表",
    "action" : "创建",
    "name" : "db01",
    "description" : "创建新的数据库",
    "result" : "success"
  } ]
}

状态码: 400

请求参数错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

状态码: 500

服务器内部错误

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

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
48
49
50
51
52
53
54
55
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.dbss.v1.region.DbssRegion;
import com.huaweicloud.sdk.dbss.v1.*;
import com.huaweicloud.sdk.dbss.v1.model.*;


public class ListAuditOperateLogsSolution {

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

        DbssClient client = DbssClient.newBuilder()
                .withCredential(auth)
                .withRegion(DbssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAuditOperateLogsRequest request = new ListAuditOperateLogsRequest();
        request.withInstanceId("{instance_id}");
        OperateLogGetRequest body = new OperateLogGetRequest();
        TimeRangeBean timebody = new TimeRangeBean();
        timebody.withTimeRange("HOUR");
        body.withSize("10");
        body.withPage("1");
        body.withTime(timebody);
        request.withBody(body);
        try {
            ListAuditOperateLogsResponse response = client.listAuditOperateLogs(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
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdbss.v1.region.dbss_region import DbssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdbss.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 = DbssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DbssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAuditOperateLogsRequest()
        request.instance_id = "{instance_id}"
        timebody = TimeRangeBean(
            time_range="HOUR"
        )
        request.body = OperateLogGetRequest(
            size="10",
            page="1",
            time=timebody
        )
        response = client.list_audit_operate_logs(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
38
39
40
41
42
43
44
45
46
47
48
49
package main

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

    request := &model.ListAuditOperateLogsRequest{}
	request.InstanceId = "{instance_id}"
	timeRangeTime:= "HOUR"
	timebody := &model.TimeRangeBean{
		TimeRange: &timeRangeTime,
	}
	sizeOperateLogGetRequest:= "10"
	pageOperateLogGetRequest:= "1"
	request.Body = &model.OperateLogGetRequest{
		Size: &sizeOperateLogGetRequest,
		Page: &pageOperateLogGetRequest,
		Time: timebody,
	}
	response, err := client.ListAuditOperateLogs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

成功

400

请求参数错误

403

认证失败

500

服务器内部错误

错误码

请参见错误码

相关文档