1. API Description
Domain name for API request: yunjing.tencentcloudapi.com.
This API is used to get the unusual login location data in the weekly CWP Pro report.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common parameter. The value used for this API: DescribeWeeklyReportNonlocalLoginPlaces. |
| Version |
Yes |
String |
Common parameter. The value used for this API: 2018-02-28. |
| Region |
No |
String |
Common parameter. This parameter is not required for this API. |
| BeginDate |
Yes |
Date |
Weekly CWP Pro report start time. |
| Limit |
No |
Integer |
Number of results to be returned. Default value: 10. Maximum value: 100. |
| Offset |
No |
Integer |
Offset. Default value: 0. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| WeeklyReportNonlocalLoginPlaces |
Array of WeeklyReportNonlocalLoginPlace |
Unusual login location data in weekly CWP Pro report |
| TotalCount |
Integer |
Total number of records. |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Getting unusual login location data in weekly CWP Pro report
This example shows you how to get the unusual login location data in the weekly CWP Pro report.
https:
&BeginDate=2018-10-08
&Limit=10
&Offset=0
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
"WeeklyReportNonlocalLoginPlaces": [
{
"MachineIp": "10.10.10.12",
"Username": "root",
"SrcIp": "139.12.12.12",
"Country": 1,
"Province": 1,
"City": 1,
"LoginTime": "2018-10-11 12:12:22"
}
],
"TotalCount": 100
}
}
5. Developer Resources
API Explorer
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code |
Description |
| InternalError |
Internal error. |
| InvalidParameter.IllegalRequest |
Invalid request. |
| InvalidParameter.InvalidFormat |
Incorrect parameter format. |