文档首页 > > API参考> API> 追踪器管理> 创建追踪器

创建追踪器

分享
更新时间: 2019/12/18 GMT+08:00

本章节所介绍的所有接口url,均对大小写敏感,请在调用时额外关注。

功能介绍

云审计服务开通后系统会自动创建一个追踪器,用来关联系统记录的所有操作。目前,一个云账户在一个Region下仅支持创建一个追踪器。

云审计服务支持在管理控制台查询近7天内的操作记录。如需保存更长时间的操作记录,您可以在创建追踪器之后通过对象存储服务(Object Storage Service,以下简称OBS)将操作记录实时保存至OBS桶中。

配置关键事件通知:用户可以选择是否在发生关键操作时通过邮件、短信或HTTP/HTTPS等方式通知用户。该功能由云审计服务触发,消息通知服务(SMN)完成通知发送,因此在启用该配置项前,需要启用消息通知服务,并创建通知主题。用户可根据具体使用场景,选择“典型”和“完整”两种触发场景:
  • 典型:适用于企业日常审计,目前支持对ECS/VPC/EVS/KMS部分核心资源的创建和删除操作以及IAM服务的登录操作等关键操作进行通知。

    由于IAM是Global服务,因此“登录”操作通知项仅在当前局点的中心region呈现。启用后,任何Region的登录都会收到消息通知。

  • 完整:更适合对接用户自有审计系统,支持对ECS/IMS/EVS/CSBS/VBS/VPC/DNS/ELB/IAM/KMS/RDS/DDS/SFS/DMS资源的创建、删除、变更以及通过调用底层Openstack的API接口触发的相关操作发送SMN通知。该模式下用户不可配置,默认发送对象为支持服务的所有事件。此场景下建议用户使用订阅协议为https的SMN主题。

URI

POST /v1.0/{project_id}/tracker

参数说明请参见 表1
表1 URI格式的参数说明

名称

是否必选

参数类型

说明

project_id

String

项目ID

请求

  • 参数说明
    表2 请求样例的参数说明

    参数名称

    子参数名称

    是否必选

    参数类型

    说明

    bucket_name

    -

    String

    标识OBS桶名称。由数字或字母开头,支持小写字母、数字、“-”、“.”,长度为3~63个字符。

    file_prefix_name

    -

    String

    标识需要存储于OBS的日志文件前缀,0-9,a-z,A-Z,'-','.','_'长度为0~64字符。

    smn

    is_support_smn

    布尔

    是否支持发送通知,当值为false时,topic_id和operations可以为空。

    topic_id

    String

    从SMN获取:urn:smn:([a-z]|[A-Z]|[0-9]|\-){1,32}:([a-z]|[A-Z]|[0-9]){32}:([a-z]|[A-Z]|[0-9]|\-|\_){1,256}。

    operations

    数组

    • “典型”场景下,发送通知触发条件为delete、create、login,并至少包含一个条件。
    • “完整”场景下,发送通知触发条件为delete、create、change和OpenStack API Evant,默认全选,不支持用户配置。

    is_send_all_key_operation

    布尔

    smn发送事件通知选择典型模式或者完整模式。

    • 值为false时operations参数不能为空。
    • 值为true时不支持添加operations参数。

    need_notify_user_list

    数组

    “典型”场景下,设置“登录”消息通知功能关注的用户列表。

    • 开启此功能时,值为“登录”消息通知功能关注的用户名称列表,多个用户名称之间用逗号“,”隔开。最多支持关注50个用户。
    • 为空时,则默认关注当前租户下所有用户。

    is_obs_created

    -

    布尔

    是否支持新建OBS桶。

    • 值为“true”时,表示新创建OBS桶存储事件文件;
    • 值为“false”时,选择已存在的OBS桶存储事件文件。

    桶名称包含数字、字母、'-'和'.'(非数字、字母类字符最多存在1个),长度为3~64字符。

    is_support_trace_files_encryption

    -

    布尔

    事件文件转储加密功能开关。该参数必须与kms_id参数同时使用。

    kms_id

    -

    String

    事件文件转储加密所采用的秘钥id(从KMS获取)。

    当"is_support_trace_files_encryption"参数值为“是”时,此参数为必选项。

    lts

    is_lts_enabled

    布尔

    是否启用日志服务检索功能

    log_group_name

    String

    云审计服务在日志服务中创建的日志组名称。

    log_topic_name

    String

    云审计服务在日志服务中创建的日志主题名称。

    log_file_validate

    -

    json

    事件文件检验。

    -

    is_support_validate

    布尔

    是否打开事件文件校验。

  • 请求样例
    POST /v1.0/{project_id}/tracker
    {
        "bucket_name": "obs-f1da",
        "is_support_trace_files_encryption": true,
        "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504",
        "is_obs_created": true,
        "file_prefix_name": "yO8Q",
        "smn": {
            "is_support_smn": true,
            "topic_id": "urn:smn:regionId:ea79855fbe0642718cb4df1551c3cb4e:hh",
            "is_send_all_key_operation": false,
            "operations": [
                "delete",
                "create",
                "login"
            ],
            "need_notify_user_list": [
                "user1",
                "user2"
            ]
        },
        "lts": {
            "is_lts_enabled": true,
            "log_group_name": "CTS",
            "log_topic_name": "system-trace"
        },
        "log_file_validate": {
            "is_support_validate": true
        }
    }

响应

  • 参数说明
    表3 响应样例的要素说明

    参数名称

    子参数名称

    参数类型

    说明

    bucket_name

    -

    String

    标识OBS桶名称。由数字或字母开头,支持小写字母、数字、“-”、“.”,长度为3~63个字符。

    file_prefix_name

    -

    String

    标识需要存储于OBS的日志文件前缀。

    status

    -

    String

    标识追踪器状态,该接口返回正常状态(enabled)。

    tracker_name

    -

    String

    标识追踪器名称,当前版本默认为“system”。

    smn

    is_support_smn

    Boolean

    是否支持发送通知

    topic_id

    String

    SMN服务的主题

    operations

    数组

    • “典型”场景下,发送通知触发条件为delete、create、login,并至少包含一个条件。
    • “完整”场景下,发送通知触发条件为delete、create、change和OpenStack API Evant,默认全选,不支持用户配置

    is_send_all_key_operation

    Boolean

    smn发送事件通知选择典型模式或者完整模式。

    • 值为false时operations参数不能为空。
    • 值为true时不支持添加operations参数。

    need_notify_user_list

    数组

    “典型”场景下,设置“登录”消息通知功能关注的用户列表。

    • 开启此功能时,值为“登录”消息通知功能关注的用户名称列表,多个用户名称之间用逗号“,”隔开。最多支持关注50个用户。
    • 为空时,则默认关注当前租户下所有用户。

    is_obs_created

    -

    Boolean

    是否支持新建OBS桶。

    • 值为“true”时,表示新创建OBS桶存储事件文件;
    • 值为“false”时,选择已存在的OBS桶存储事件文件。

    桶名称包含数字、字母、'-'和'.'(非数字、字母类字符最多存在1个),长度为3~64字符。

    is_support_trace_files_encryption

    -

    Boolean

    事件文件转储加密功能开关。该参数必须与kms_id参数同时使用。

    kms_id

    -

    String

    事件文件转储加密所采用的秘钥id(从KMS获取)。

    当"is_support_trace_files_encryption"参数值为“是”时,此参数为必选项。

    lts

    is_lts_enabled

    Boolean

    云审计服务在日志服务中创建的日志组名称

    log_topic_name

    String

    云审计服务在日志服务中创建的日志主题名称

    log_group_id

    String

    云审计服务在日志服务中创建的日志组id

    log_topic_id

    String

    云审计服务在日志服务中创建的日志主题id

    log_file_validate

    log_file_validate

    json对象

    事件文件检验

    is_support_validate

    is_support_validate

    布尔

    是否打开事件文件校验

  • 响应样例
    {
        "bucket_name": "obs-f1da",
        "file_prefix_name": "yO8Q",
        "is_obs_created": true,
        "is_support_trace_files_encryption": true,
        "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504",
        "smn": {
            "is_support_smn": true,
            "topic_id": "urn:smn:regionId:ea79855fbe0642718cb4df1551c3cb4e:hh",
            "is_send_all_key_operation": false,
            "operations": [
                "delete",
                "create",
                "login"
            ],
            "need_notify_user_list": [
                "user1",
                "user2"
            ]
        },
        "lts": {
            "is_lts_enabled": true,
            "log_group_name": "CTS",
            "log_topic_name": "system-trace",
            "log_group_id": "b6895f40-b897-11e7-8aa6-2866d488c81c",
            "log_topic_id": "b68d5281-b897-11e7-8aa7-2866d488c81c"
        },
        "log_file_validate": {
            "is_support_validate": true
        },
        "tracker_name": "system",
        "status": "enabled"
    }

返回值

  • 正常
    表4 正常返回值说明

    返回值

    说明

    201

    请求成功。

  • 异常
    表5 异常返回值说明

    返回值

    说明

    400

    服务器未能处理请求。

    403

    请求权限校验失败,访问被禁止。

    500

    服务内部异常,请求未完成。

    401

    请求鉴权校验失败,访问被拒绝。

    404

    请求中的OBS桶不存在,请求未完成。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区