查询事件列表
功能介绍
通过事件列表查询接口,可以查出系统记录的7天内资源操作记录。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/traces
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        project_id  | 
      
        是  | 
      
        String  | 
      
        项目ID,参见获取账号ID和项目ID章节。  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        trace_type  | 
      
        是  | 
      
        String  | 
      
        标识审计事件类型。 目前支持管理类事件(system)和数据类事件(data)。 默认值为"system"。  | 
     
| 
        from  | 
      
        否  | 
      
        Long  | 
      
        标识查询事件列表的起始时间戳(timestamp,为标准UTC时间,毫秒级,13位数字,不包括传入时间)默认为上一小时的时间戳。查询条件from与to配套使用。  | 
     
| 
        next  | 
      
        否  | 
      
        String  | 
      
        取值为响应中中marker的值,用于标识查询事件的起始时间(自此条事件的记录时间起,向更早时间查询)。 可以与“from”、“to”结合使用。 最终的查询条件取两组时间条件的交集。  | 
     
| 
        to  | 
      
        否  | 
      
        Long  | 
      
        标识查询事件列表的结束时间戳(timestamp,为标准UTC时间,毫秒级,13位数字,不包括传入时间)默认为当前时间戳。查询条件to与from配套使用。  | 
     
| 
        tracker_name  | 
      
        否  | 
      
        String  | 
      
        当"trace_type"字段值为"system"时,该字段值默认为"system"。 当"trace_type"字段值为"data"时,该字段值可以传入数据类追踪器名称,达到筛选某个数据类追踪器下的数据事件目的。  | 
     
| 
        service_type  | 
      
        否  | 
      
        String  | 
      
        标识查询事件列表对应的云服务类型。必须为已对接CTS的云服务的英文缩写,且服务类型一般为大写字母。 当"trace_type"字段值为"system"时,该字段筛选有效"。 已对接的云服务列表参见《云审计服务用户指南》“支持审计的服务及详细操作列表”章节。  | 
     
| 
        user  | 
      
        否  | 
      
        String  | 
      
        标识特定用户名称,用以查询该用户下的所有事件。 当"trace_type"字段值为"system"时,该字段筛选有效"。  | 
     
| 
        resource_name  | 
      
        否  | 
      
        String  | 
      
        标示查询事件列表对应的的资源名称。 当"trace_type"字段值为"system"时,该字段筛选有效"。 说明:该字段可能包含大写字母。  | 
     
| 
        resource_type  | 
      
        否  | 
      
        String  | 
      
        标示查询事件列表对应的资源类型。 当"trace_type"字段值为"system"时,该字段筛选有效"。  | 
     
| 
        resource_id  | 
      
        否  | 
      
        String  | 
      
        标示查询事件列表对应的云服务资源ID。 当"trace_type"字段值为"system"时,该字段筛选有效"。  | 
     
| 
        limit  | 
      
        否  | 
      
        Integer  | 
      
        标示查询事件列表中限定返回的事件条数。不传时默认10条,最大值200条。  | 
     
| 
        trace_id  | 
      
        否  | 
      
        String  | 
      
        标示某一条事件的事件ID。当传入这个查询条件时,其他查询条件自动不生效。 当"trace_type"字段值为"system"时,该字段筛选有效"。  | 
     
| 
        trace_name  | 
      
        否  | 
      
        String  | 
      
        标示查询事件列表对应的事件名称。 当"trace_type"字段值为"system"时,该字段筛选有效"。 说明:该字段可能包含大写字母。  | 
     
| 
        trace_rating  | 
      
        否  | 
      
        String  | 
      
        标示查询事件列表对应的事件等级目前有三种:正常(normal), 警告(warning),事故(incident)。 当"trace_type"字段值为"system"时,该字段筛选有效"。  | 
     
| 
        access_key_id  | 
      
        否  | 
      
        String  | 
      
        标示查询事件列表对应的访问密钥ID。包含临时访问凭证和永久访问密钥。  | 
     
| 
        enterprise_project_id  | 
      
        否  | 
      
        String  | 
      
        标示查询事件列表对应的企业项目ID。  | 
     
请求参数
无
响应参数
状态码:200
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        traces  | 
      
        Array of Traces objects  | 
      
        本次查询事件列表返回事件数组。  | 
     
| 
        meta_data  | 
      
        MetaData object  | 
      
        本次查询事件条数和标记位。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        resource_id  | 
      
        String  | 
      
        标识事件对应的云服务资源ID。  | 
     
| 
        trace_name  | 
      
        String  | 
      
        标识查询事件列表对应的事件名称。由0-9,a-z,A-Z,'-','.','_',组成,长度为1~64个字符,且以首字符必须为字母。  | 
     
| 
        trace_rating  | 
      
        String  | 
      
        标识事件等级,目前有三种:正常(normal),警告(warning),事故(incident)。  | 
     
| 
        trace_type  | 
      
        String  | 
      
        标识事件发生源头类型,管理类事件主要包括API调用(ApiCall),Console页面调用(ConsoleAction)和系统间调用(SystemAction)。数据类事件主要包括ObsSDK,ObsAPI。  | 
     
| 
        request  | 
      
        String  | 
      
        标识事件对应接口请求内容,即资源操作请求体。  | 
     
| 
        response  | 
      
        String  | 
      
        记录用户请求的响应,标识事件对应接口响应内容,即资源操作结果返回体。  | 
     
| 
        code  | 
      
        String  | 
      
        记录用户请求的响应,标识事件对应接口返回的HTTP状态码。  | 
     
| 
        api_version  | 
      
        String  | 
      
        标识事件对应的云服务接口版本。  | 
     
| 
        message  | 
      
        String  | 
      
        标识其他云服务为此条事件添加的备注信息。  | 
     
| 
        record_time  | 
      
        Long  | 
      
        标识云审计服务记录本次事件的时间戳。  | 
     
| 
        trace_id  | 
      
        String  | 
      
        标识事件的ID,由系统生成的UUID。  | 
     
| 
        time  | 
      
        Long  | 
      
        标识事件产生的时间戳。  | 
     
| 
        user  | 
      
        UserInfo object  | 
      
        标识触发事件的用户信息。  | 
     
| 
        service_type  | 
      
        String  | 
      
        标识查询事件列表对应的云服务类型。必须为已对接CTS的云服务的英文缩写,且服务类型一般为大写字母。  | 
     
| 
        resource_type  | 
      
        String  | 
      
        查询事件列表对应的资源类型。  | 
     
| 
        source_ip  | 
      
        String  | 
      
        标识触发事件的租户IP。  | 
     
| 
        resource_name  | 
      
        String  | 
      
        标识事件对应的资源名称。  | 
     
| 
        request_id  | 
      
        String  | 
      
        记录本次请求的request id  | 
     
| 
        location_info  | 
      
        String  | 
      
        记录本次请求出错后,问题定位所需要的辅助信息。  | 
     
| 
        endpoint  | 
      
        String  | 
      
        云资源的详情页面  | 
     
| 
        resource_url  | 
      
        String  | 
      
        云资源的详情页面的访问链接(不含endpoint)  | 
     
| 
        enterprise_project_id  | 
      
        String  | 
      
        标识资源所在的企业项目ID。  | 
     
| 
        resource_account_id  | 
      
        String  | 
      
        标识资源所在的账号ID。仅在跨租户操作资源时有值。  | 
     
| 
        read_only  | 
      
        Boolean  | 
      
        标识用户请求是不是只读。  | 
     
| 
        operation_id  | 
      
        String  | 
      
        记录事件对应的操作ID。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        id  | 
      
        String  | 
      
        用户ID,参见《云审计服务API参考》“获取账号ID和项目ID”章节。  | 
     
| 
        name  | 
      
        String  | 
      
        用户名称。  | 
     
| 
        user_name  | 
      
        String  | 
      
        用户名称。  | 
     
| 
        domain  | 
      
        BaseUser object  | 
      
        标识触发事件的用户domain信息。  | 
     
| 
        account_id  | 
      
        String  | 
      
        账号ID,参见《云审计服务API参考》“获取账号ID和项目ID”章节。  | 
     
| 
        access_key_id  | 
      
        String  | 
      
        访问密钥ID。  | 
     
| 
        principal_urn  | 
      
        String  | 
      
        操作用户身份的 URN。 
  | 
     
| 
        principal_id  | 
      
        String  | 
      
        操作用户身份Id。 
  | 
     
| 
        principal_is_root_user  | 
      
        String  | 
      
        是否是根用户。  | 
     
| 
        type  | 
      
        String  | 
      
        操作者身份类型。  | 
     
| 
        invoked_by  | 
      
        Array of strings  | 
      
        发出请求的服务的名称。控制台操作时为["service.console" ]  | 
     
| 
        session_context  | 
      
        SessionContext object  | 
      
        临时安全凭据属性。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        created_at  | 
      
        String  | 
      
        颁发临时安全凭证时的时间(timestamp,为标准UTC时间,毫秒级,13位数字)。  | 
     
| 
        mfa_authenticated  | 
      
        String  | 
      
        是否已经通过MFA身份认证。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        count  | 
      
        Integer  | 
      
        标识本次查询事件列表返回的事件记录的总条数。  | 
     
| 
        marker  | 
      
        String  | 
      
        标识本次查询事件列表返回的最后一个事件ID。可以使用这个参数返回值作为分页请求参数next的值,如果marker返回为null,则表示当前请求条件下查询事件列表已经全部返回没有下一页。  | 
     
状态码:400
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误码标识,CTS.XXX。  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误描述。  | 
     
状态码:401
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误码标识,CTS.XXX。  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误描述。  | 
     
状态码:403
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误码标识,CTS.XXX。  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误描述。  | 
     
状态码:404
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误码标识,CTS.XXX。  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误描述。  | 
     
状态码:500
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误码标识,CTS.XXX。  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误描述。  | 
     
状态码:503
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        错误码标识,CTS.XXX。  | 
     
| 
        error_msg  | 
      
        String  | 
      
        错误描述。  | 
     
请求示例
- 
    
    
GET https://{endpoint}/v3/{project_id}/traces?limit=11&to=1479095278000&from=1478490478000&trace_name=createTracker&resource_type=tracker&service_type=CTS&trace_type=system - 
    
    
GET https://{endpoint}/v3/{project_id}/traces?limit=11&to=1479095278000&from=1478490478000&trace_type=data 
响应示例
状态码:200
请求正常。
{
  "traces" : [ {
    "request" : "",
    "code" : "204",
    "source_ip" : "192.168.0.92",
    "trace_type" : "ConsoleAction",
    "read_only" : false,
    "operation_id" : "DeletePublicip",
    "trace_id" : "9650eb5a-f57c-11ef-8503-ef3069828c92",
    "trace_name" : "deleteEip",
    "resource_type" : "publicip",
    "trace_rating" : "normal",
    "api_version" : "v3",
    "message" : "",
    "service_type" : "EIP",
    "response" : "",
    "resource_id" : "3224b58b-fca5-4902-a2a3-05757f29da22",
    "resource_account_id" : "230657***34fcd9",
    "time" : 1740710091805,
    "resource_name" : "-",
    "request_id" : "4eb208ad0b84115d2825c1f1b4482ff1",
    "user" : {
      "access_key_id" : "HSTAM5***37Z39R",
      "invoked_by" : [ "service.console" ],
      "account_id" : "230657***34fcd9",
      "user_name" : "test",
      "domain" : {
        "name" : "paas_cts_z00418070_01",
        "id" : "230657***34fcd9"
      },
      "name" : "test",
      "session_context" : {
        "attributes" : {
          "created_at" : "1740710036558",
          "mfa_authenticated" : "false"
        }
      },
      "principal_is_root_user" : "false",
      "id" : "969ba3***28d3d0",
      "principal_urn" : "iam::230657***34fcd9:user:test",
      "type" : "User",
      "principal_id" : "969ba3***28d3d0"
    },
    "record_time" : 1740710091805
  }, {
    "request" : "tag_types=predefine&domainId=230657***34fcd9",
    "trace_id" : "7f64160a-f57c-11ef-8503-ef3069828c92",
    "code" : "200",
    "trace_name" : "getResourceTags",
    "resource_type" : "tags",
    "trace_rating" : "normal",
    "api_version" : "1.0",
    "source_ip" : "10.63.127.2",
    "trace_type" : "ConsoleAction",
    "service_type" : "TMS",
    "read_only" : true,
    "operation_id" : "GetResourceTags",
    "resource_account_id" : "230657***34fcd9",
    "time" : 1740710053352,
    "user" : {
      "access_key_id" : "HSTAM5***37Z39R",
      "invoked_by" : [ "service.console" ],
      "account_id" : "230657***34fcd9",
      "user_name" : "test",
      "domain" : {
        "name" : "paas_cts_z00418070_01",
        "id" : "230657***34fcd9"
      },
      "name" : "test",
      "session_context" : {
        "attributes" : {
          "created_at" : "1740710036558",
          "mfa_authenticated" : "false"
        }
      },
      "principal_is_root_user" : "false",
      "id" : "969ba3***28d3d0",
      "principal_urn" : "iam::230657***34fcd9:user:test",
      "type" : "User",
      "principal_id" : "969ba3***28d3d0"
    },
    "record_time" : 1740710053352
  } ],
  "meta_data" : {
    "count" : 2
  }
}
 状态码
| 
        状态码  | 
      
        描述  | 
     
|---|---|
| 
        200  | 
      
        请求正常。  | 
     
| 
        400  | 
      
        查询参数异常,请求未完成。  | 
     
| 
        401  | 
      
        请求鉴权校验失败,访问被拒绝。  | 
     
| 
        403  | 
      
        请求权限校验失败,访问被禁止。  | 
     
| 
        404  | 
      
        查询事件不存在,请求未完成。  | 
     
| 
        500  | 
      
        服务内部异常,请求未完成。  | 
     
| 
        503  | 
      
        被请求的服务无效。建议直接修改该请求,不要重试该请求。  | 
     
错误码
请参见错误码。