文档

DescribeLoginBaseConfigs - 查询异常登录检测规则的配置

更新时间:

查询服务器异常登录检测规则的配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeLoginBaseConfigsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageSizeinteger

设置分页查询时,每页显示的登录配置信息的数量。默认值为 5,表示每页显示 5 条登录配置信息。

5
Typestring

要查询的登录配置信息的类型。取值:

  • login_common_location:常用登录地。
  • login_common_ip:常用登录 IP。
  • login_common_time:常用登录时间。
  • login_common_account:常用登录账号。
login_common_location
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
Targetstring

策略生效的资产的选择模式。此参数为 JSON 格式,包含以下参数:

  • Target:要添加或删除的服务器的 UUID 或服务器所在的分组 ID。
说明 当参数 targetType 的取值为 uuid 时,该参数取值为服务器的 UUID。当参数 targetType 的取值为 groupId 时,该参数的取值为服务器所在的分组 ID。当参数 targetType 的取值为 global 时,该参数取值为中划线(-)。
  • targetType:生效资产的选择模式。取值:
    • uuid:按单个服务器查询。
    • groupId:按照服务器分组查询。
    • global:表示查询所有服务器。
[ {"target": "inet-7c676676-06fa-442e-90fb-b802e5d6****", "targetType": "uuid" } ]

返回参数

名称类型描述示例值
object

异常登录检测规则的配置返回数据。

CurrentPageinteger

分页查询时,当前页的页码。

1
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

2C2D4B3C-0524-17B1-93D2-DA50119F4E1E
PageSizeinteger

分页查询时,每页显示的登录配置信息的数量。默认值为 20,表示每页显示 20 条登录配置信息。

20
TotalCountinteger

查询到的登录配置信息的总数量。

200
BaseConfigsobject []

登录配置信息的详情列表。

EndTimestring

常用登录时间的结束时间。

07:00
Accountstring

常用登录账号。

1582318****
StartTimestring

常用登录时间的开始时间。

08:00
Ipstring

常用登录 IP。

192.168.XX.XX
TotalCountinteger

服务器的总数量。

172
UuidCountinteger

规则生效的服务器的数量。

13
Locationstring

常用登录地。

BeiJing
TargetListobject []

规则生效的服务器的详细信息列表。

Targetstring

规则生效的服务器的 UUID 或者服务器其所在的分组 ID。

0011ea53-738c-4bff-93be-ce6a1cc9****
TargetTypestring

生效资产的选择模式。取值:

  • uuid:按单个资产添加。
  • groupId:按照服务器分组添加。
  • global:表示选择所有资产。
uuid
Remarkstring

对应配置备注显示的信息。

test

示例

正常返回示例

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "2C2D4B3C-0524-17B1-93D2-DA50119F4E1E",
  "PageSize": 20,
  "TotalCount": 200,
  "BaseConfigs": [
    {
      "EndTime": "07:00",
      "Account": "1582318****",
      "StartTime": "08:00",
      "Ip": "192.168.XX.XX",
      "TotalCount": 172,
      "UuidCount": 13,
      "Location": "BeiJing",
      "TargetList": [
        {
          "Target": "0011ea53-738c-4bff-93be-ce6a1cc9****",
          "TargetType": "uuid"
        }
      ],
      "Remark": "test"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-04-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈