Domain name for API request: cwp.tencentcloudapi.com.
This API is used to add cross-region log-in allowlists in batches.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: AddLoginWhiteLists. |
Version | Yes | String | Common Params. The value used for this API: 2018-02-28. |
Region | No | String | Common Params. This parameter is not required. |
HostLoginWhiteObj | Yes | HostLoginWhiteObj | Cross-region log-in allowlist entity |
ProcessType | No | String | Synchronous event processing method: "": do not process"All": add all events that match this configuration to the allowlist"Id": add the event corresponding to the event ID to the allowlist |
EventId | No | Integer | Cross-region log-in event ID. This parameter is required when ProcessType is set to Id. |
Parameter Name | Type | Description |
---|---|---|
DuplicateHosts | Array of DuplicateHosts | Prompt list of duplicate addition Note: This field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to add cross-region log-in allowlists in batches.
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddLoginWhiteLists
<Common request parameters>
{
"EventId": 11234,
"ProcessType": "Id",
"HostLoginWhiteObj": {
"UserName": "xx",
"Remark": "xx",
"Places": [
{
"CityId": 0,
"CountryId": 0,
"ProvinceId": 135
}
],
"IsGlobal": 0,
"HostInfos": [
{
"Quuid": "66640e61-aaaa-4632-aaaa-aaaa037e7ba0",
"Uuid": "66640e61-aaaa-4632-aaaa-aaaa037e7ba0"
}
],
"StartTime": "00:00",
"SrcIp": "1.2.3.4",
"EndTime": "00:01"
}
}
{
"Response": {
"RequestId": "4234234",
"Error": {
"Code": "InvalidParameter.RuleHostipErr",
"Message": "No information on the corresponding host found."
}
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Incorrect parameter. |
InvalidParameter.MissingParameter | Missing parameter. |
InvalidParameter.ParsingError | Incorrect parameter parsing. |
InvalidParameter.RuleHostDuplicateErr | Rule-based API with duplicate hosts. |
InvalidParameter.RuleHostipErr | Rule-based API with incorrect host IPs. |
InvalidParameterValue | Invalid parameter value. |
MissingParameter | Missing parameter error. |
Was this page helpful?