Domain name for API request: csip.intl.tencentcloudapi.com.
This API is used to query the list of allowlisted machines after merge.
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: DescribeLoginWhiteHostList. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| Id | Yes | Integer | Allowlist ID |
| Limit | Yes | Integer | Number of records to return. Maximum value: 1000 |
| Offset | Yes | Integer | Offset. Default value: 0. |
| MemberId.N | No | Array of String | Group account member id |
| Filters.N | No | Array of AssetFilters | Filter criteria IpOrAlias - String - Required: No - host ip or alias filter |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total. |
| Hosts | Array of HostDesc | Server list |
| 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 edit the log-in audit allowlist.
POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoginWhiteHostList
<Common request parameters>
{
"Limit": 1,
"Id": 1,
"Offset": 1
}{
"Response": {
"TotalCount": 1,
"Hosts": [
{
"MachineName": "Machine name",
"Quuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
"MachineWanIp": "1.1.1.1",
"Uuid": "05f0bcab-726c-4ea4-8109-bcd03d5598f7",
"MachineIp": "1.1.1.1",
"Tags": [
{
"Name": "cwp",
"TagId": 1,
"Rid": 1
}
]
}
],
"RequestId": "be6f6eec-0825-4e67-ab9a-c8568bbf736c"
}
}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 | Parameter error. |
| InvalidParameter.MissingParameter | InvalidParameter.MissingParameter |
| InvalidParameter.ParsingError | InvalidParameter.ParsingError |
| InvalidParameter.RuleHostDuplicateErr | InvalidParameter.RuleHostDuplicateErr |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
文档反馈