查询审计日志。
适用版本 | 企业专属版 |
服务接入点与授权信息
获取个人访问令牌,具体操作,请参见获取个人访问令牌。
获取服务接入点,替换 API 请求语法中的 <domain> :服务接入点(domain)。
产品
资源
所需权限
基础服务
审计日志
只读
请求语法
GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/auditLogs
请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 组织 ID。 | 99d1****71d4 |
userIds | string | query | 否 | 用户 ID 列表,以','分隔。 | 99d1****71d4 |
apps | string | query | 否 | 应用 identity 列表,以','分隔。 | 示例应用名 |
actionTimeStart | string | query | 是 | 查询开始时间范围(包含)。RFC3339 格式,如'2023-09-30T00:00:00.00Z'。 | 2023-09-30T00:00:00.00Z |
actionTimeEnd | string | query | 否 | 查询结束时间范围,默认当前时间。RFC3339 格式,如'2023-09-30T00:00:00.00Z'。 | 2023-08-31T03:59:16.201Z |
perPage | integer | query | 否 | 每页数据条数,默认100。 | 20 |
nextToken | string | query | 否 | 分页凭证。 |
请求示例
curl -X 'GET' \
'https://test.rdc.aliyuncs.com/oapi/v1/platform/organizations/{organizationId}/auditLogs?userIds={userIds}&apps={apps}&actionTimeStart={actionTimeStart}&actionTimeEnd={actionTimeEnd}&perPage={perPage}&nextToken={nextToken}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'
返回参数
参数 | 类型 | 描述 | 示例值 |
- | array | ||
- | object | ||
action | string | 操作。 | login |
actionTime | string | 操作时间。 | 2023-08-31T03:59:16.201Z |
app | object | 应用信息。 | |
identity | string | 应用标识。 | base |
name | string | 应用名称。 | 示例应用名 |
appId | string | 应用 ID。 | 99d1****6124 |
detail | string | 操作内容。 | xxx login |
id | string | 审计日志 ID, 全局唯一。 | 99d1****6124 |
ip | string | IP 地址。 | 192...1 |
organization | object | 组织信息。 | |
id | string | 组织 ID。 | 99d1****6124 |
name | string | 组织名称。 | 示例名 |
organizationId | string | 组织 ID。 | 99d1****6124 |
scope | string | 操作日志归属范围。 | org |
targetId | string | 操作对象 ID。 | 99d1****6124 |
targetType | string | 操作对象类型。 | user |
user | object | 操作者信息。 | |
id | string | 用户 ID。 | 99d1****6124 |
name | string | 用户名称。 | 示例名 |
nickName | string | 用户昵称。 | 示例昵称 |
userId | string | 操作者 ID。 | 99d1****6124 |
返回示例
[
{
"action": "login",
"actionTime": "2023-08-31T03:59:16.201Z",
"app": {
"identity": "base",
"name": "示例应用名"
},
"appId": "99d1****6124",
"detail": "xxx login",
"id": "99d1****6124",
"ip": "192.*.*.1",
"organization": {
"id": "99d1****6124",
"name": "示例名"
},
"organizationId": "99d1****6124",
"scope": "org",
"targetId": "99d1****6124",
"targetType": "user",
"user": {
"id": "99d1****6124",
"name": "示例名",
"nickName": "示例昵称"
},
"userId": "99d1****6124"
}
]
响应头
参数 | 描述 | 示例值 |
x-next-token | 后续页凭证。 |
标题错误码
访问错误码中心查看 API 相关错误码。