1. 接口描述
接口请求域名: csip.tencentcloudapi.com 。
查询用户行为分析策略列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeUebaRule。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-21。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
MemberId.N | 否 | Array of String | 集团账号的成员id 示例值:["mem-6wfo0fzks3","mem-85fo0fzks4"] |
Filter | 否 | Filter | 过滤条件 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数 示例值:12 |
Data | Array of UebaRule | 策略列表 示例值:[{"RuleID":"rule-k23p01f","RuleName":"11","RuleStatus":true,"HitCount":0,"AppID":"192**01","CloudType":0}] |
AlterType | Array of FilterDataObject | 自定义策略对应的告警类别枚举 示例值:[ { "Text": "用户异常行为", "Value": "AbnormalUserBehavior" } ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 test
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUebaRule
<公共请求参数>
{
"Filter": {
"Filters": [
{
"Name": "RuleType",
"Values": [
"0"
],
"OperatorType": 7
}
],
"Limit": 10,
"Offset": 0
},
"MemberId": [
"mem-e5d75d512c934d2c"
]
}
输出示例
{
"Response": {
"AlterType": [
{
"Text": "用户异常行为",
"Value": "AbnormalUserBehavior"
}
],
"Data": [
{
"RuleID": "rule-k23p01f",
"RuleName": "11",
"RuleType": 1,
"RuleLevel": 4,
"RuleContent": "用户类型: 云用户 日志类型: AWS日志(云审计)\n逻辑表达式: (account_id 等于 10) \n统计条件:不基于统计检测",
"RuleStatus": true,
"HitCount": 0,
"AppID": "79254734186",
"Uin": "arn:aws-cn:iam::792***4186:user/TC_20240510_nZFQ",
"MemberID": "mem-aws-b****e82cb251dd",
"Nickname": "TC_20240510_nZFQ",
"CloudType": 0,
"CustomRuleDetail": {
"RuleName": "11",
"UserType": 1,
"LogType": "8_3",
"LogTypeStr": "AWS日志(云审计)",
"TimeInterval": 1,
"EventContent": {
"EventType": 2,
"Content": "zero**",
"Filters": [
{
"Name": "account_id",
"Values": [
"10"
],
"OperatorType": 0
}
]
},
"AlertName": "AbnormalUserBehavior",
"AlterLevel": 4,
"Operator": [
"account_id",
"action_type"
],
"OperateObject": [
"account_id"
],
"OperateMethod": [
"account_id"
]
}
}
],
"RequestId": "7da0af7a-c1c7-4739-8961-1492d37d693a",
"TotalCount": 76
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。