获取异地登录白名单列表
最近更新时间: 2026-09-17 00:02:42
1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
获取异地登录白名单列表
默认接口请求频率限制:20次/秒。
接口更新时间:2022-05-20 15:12:33。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeLoginWhiteList |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件。 示例值:查看 |
| Limit | 否 | 否 | Uint64 | 返回数量,最大值为100。 示例值: 10 |
| Offset | 否 | 否 | Uint64 | 偏移量,默认为0。 示例值: 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoginWhiteLists | Array of LoginWhiteLists | 异地登录白名单数组 示例值:查看 |
| TotalCount | Uint64 | 记录总数 示例值: 12 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameter.MissingParameter | 参数缺失。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
5. 示例
示例1 获取异地登录白名单列表
获取异地登录白名单列表
输入示例
https://cwp.api3.fincloud.tencent.cn/?Action=DescribeLoginWhiteList
&Limit=10
&Offset=0
&<Public request parameters>
输出示例
{"Response ":{" LoginWhiteLists":[{"CreateTime ":" 2020 - 09 - 22 00:00:00 "," EndTime ":" 2020 - 09 - 22 00:00:00 "," HostIp ":"www.example.com","Id": 1,"IsGlobal": true,"MachineName":"Machine Name","ModifyTime":"2020 - 09 - 22 00:00:00","Places":[{" CityId ": 1," CountryId ": 1," ProvinceId ": 1},{"CityId": 1,"CountryId": 1}],"SrcIp":" 1.1.1.1"," StartTime":" 2020 - 09 - 22 00:00:00"," UserName":" root"," Uuid":" 05f0bcab-726c-4ea4 - 8109-bcd03d5598f7 "}]," RequestId":" be6f6eec-0825 - 4e67-ab9a-c8568bbf736c"," TotalCount": 1}}