文档

Python SDK调用示例

更新时间:

本文以Python SDK为例,为您介绍如何通过操作审计OpenAPI调用LookupEvents接口查询操作审计事件的详情。

步骤一:查看OpenAPI文档

在调用OpenAPI前,建议您先阅读对应的接口文档LookupEvents,了解调用该接口所需要的参数和权限,更多信息请参见API概览

步骤二:创建RAM用户并完成授权

身份

您可以使用阿里云账号(主账号)、RAM用户、RAM角色调用该接口。关于各种身份的差异,请参见身份

本示例中,使用RAM用户调用接口。

登录RAM访问控制,创建一个RAM用户。具体操作,请参见创建RAM用户

凭证

进入到对应的RAM用户详情页,在认证管理页签下的用户AccessKey区域,单击创建AccessKey,创建一个新的AccessKey。具体操作,请参见创建AccessKey

重要

RAM用户的AccessKey Secret只在创建时显示,不支持查看,请注意保存。

授权

  1. 访问RAM用户列表,单击目标RAM用户操作列的添加权限

  2. 在文本框中输入关键字actiontrail进行搜索,根据最小授权原则,选择对应权限策略。

    • AliyunActionTrailFullAccess:管理操作审计(ActionTrail)的权限。

    • AliyunActionTrailReadOnlyAccess:只读访问操作审计(ActionTrail)的权限。

    说明

    如果系统策略不能满足您的需求,您可以创建自定义策略。更多信息,请参见创建自定义权限策略授权信息

    本文示例选择AliyunActionTrailReadOnlyAccess系统策略。

  3. 单击确认新增授权,完成授权操作。

步骤三:调用OpenAPI

本文以Python SDK调用OpenAPI,其他语言SDK的用法类似。更多信息,请参见操作审计SDK。您也可根据业务的实际需要选择其他调用方式,更多调用方法请参见调用方式

准备Python环境

  1. 下载并安装Python。

    Python 3的下载地址,请参见Python 3

  2. 查看Python版本。

    • Linux和macOS系统

      打开终端,输入python --version

    • Windows系统

      • 在Python的安装路径下,双击python.exe。

      • 打开命令提示符页面。

        通过键盘快捷键Win+R打开运行对话框,输入命令python,单击确定

配置环境变量

为避免将AccessKey硬编码到业务代码中带来的安全风险,本示例采用配置环境变量的方法管理AccessKey。关于环境变量的详细配置,请参见配置AccessKey环境变量

安装依赖

pip install alibabacloud_credentials
pip install alibabacloud_actiontrail20200706==2.1.0
pip install alibabacloud_tea_console

下载示例代码

  1. 在OpenAPI门户,访问LookupEvents接口的调试地址

  2. LookupEvents接口无必填参数,可以不填写,直接单击发起调用

  3. 先单击SDK示例页签,再单击Python页签。

    获取Python语言的SDK示例。

  4. 单击下载完整工程,下载示例代码包。

  5. 在本地解压进入alibabacloud_sample目录。

运行代码

执行以下命令:

python sample.py

得到如下输出结果:

{
  "EndTime": "2023-07-11T08:13:04Z",
  "NextToken": "eyJhY2NvdW50IjoiMTY5ODI3MjMyODU0ODQ2NyIsImV2ZW50SWQiOiJFNTdGNjFGRS04RjdCLTVDRjAtODA3Ni03NjAwNEQyMkMxQTYiLCJsb2dJZCI6IjQ1LTE2OTgyNzIzMjg1NDg0NjciLCJ0aW1lIjoxNjg5MDYzMTE2MD****",
  "RequestId": "7743F214-925E-5602-936C-3CCCD5FBACD8",
  "Events": [
    {
      "eventId": "33859C72-1C50-55B3-A857-27FAA358****",
      "eventVersion": 1,
      "eventSource": "actiontrail.cn-hangzhou.aliyuncs.com",
      "requestParameters": {
        "AcsProduct": "Actiontrail",
        "UserAgent": "Workbench/1.0",
        "ClientPort": 11880,
        "Region": "cn-hangzhou"
      },
      "sourceIpAddress": "192.168.XX.XX",
      "userAgent": "api.aliyun.com",
      "eventRW": "Read",
      "eventType": "ApiCall",
      "userIdentity": {
        "sessionContext": {
          "attributes": {
            "mfaAuthenticated": "false",
            "creationDate": "2023-07-11T08:12:34Z"
          }
        },
        "accountId": "169827232854****",
        "principalId": "169827232854****",
        "type": "root-account",
        "userName": "root"
      },
      "serviceName": "Actiontrail",
      "additionalEventData": {
        "CallerBid": "2****"
      },
      "apiVersion": "2020-07-06",
      "requestId": "33859C72-1C50-55B3-A857-27FAA358641C",
      "eventTime": "2023-07-11T08:12:34Z",
      "isGlobal": false,
      "acsRegion": "cn-hangzhou",
      "eventName": "LookupEvents"
    }
  ],
  "StartTime": "2023-07-04T08:13:34Z"
}