All Products
Search
Document Center

Direct Mail:IP Protection

Last Updated:Jan 09, 2024

IP protection-related interfaces.

Enable or disable IP protection

Check whether IP protection is enabled.

Obtain IP Filter List

Add an IP address whitelist

Delete an IP Address Whitelist

Enable or Disable the IP Protection Function

Description

UpdateIpProtection enable or disable the IP protection function

Request Parameters

Parameter

Type

Required

Description

Example

IpProtection

String

Yes

IP protection switch, on: 1 off: 0

0

Action

String

Yes

The operation that you want to perform.

UpdateIpProtection

For more information about other request parameters, see Common request parameters.

Response Parameters

Parameter

Type

Description

Example

RequestId

String

Request ID

B653A6FC-D1AD-5936-A262-F50994ED2574

For more information about common response parameters, see Common response parameters.

Obtain whether the IP protection feature is enabled.

Description

GetIpProtection whether the IP protection feature is enabled

Request Parameters

Parameter

Type

Required

Description

Example

Action

String

Yes

The operation that you want to perform.

GetIpProtection

For more information about other request parameters, see Common request parameters.

Response Parameters

Parameter

Type

Description

Example

IpProtection

String

IP protection switch, on: 1 off: 0

0

RequestId

String

Request ID

B30E5A62-2E64-577D-A70E-8C6781D6C975

For more information about common response parameters, see Common response parameters.

Get IP Filter List

Description

GetIpfilterList Get IP Filter List

Request Parameters

Parameter

Type

Required

Description

Example

Action

String

Yes

The operation that you want to perform.

GetIpfilterList

For more information about other request parameters, see Common request parameters.

Response Parameters

Parameter

Type

Description

Sample value

PageSize

Integer

The number of entries to return on each page.

10

RequestId

String

Request ID

84DD77C7-A091-5139-9530-2D1F7CCE59E0

PageNumber

Integer

The page number of current page.

1

TotalCount

Integer

Total number

1

data

Object []

Detailed Records

IpAddress

String

IP address /IP interval /IP segment

Single IP address format, such as xxx.xxx.xxx.xxx

IP interval format, such as xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx IP segment format, such as xxx.xxx.xxx.xxx/xxx

Id

String

The ID of the record.

10083

CreateTime

String

The timestamp.

1653547140

For more information about common response parameters, see Common response parameters.

Configure an IP Address Allowlist

Description

AddIpfilter Add an IP address whitelist

Request Parameters

Parameter

Type

Required

Description

Example

IpAddress

String

Yes

IP address /IP interval /IP segment

Single IP address format, such as xxx.xxx.xxx.xxx IP interval format, such as xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx IP segment format, such as xxx.xxx.xxx.xxx/xxx

Action

String

Yes

The operation that you want to perform.

AddIpfilter

For more information about other request parameters, see Common request parameters.

Response Parameters

Parameter

Type

Description

Example

RequestId

String

Request ID

0E9282E8-DC08-5445-8FB0-B9F0CA28B249

IpFilterId

Integer

The ID of the ip address.

10795

For more information about common response parameters, see Common response parameters.

Delete an IP Address Whitelist

Description

DeleteIpfilterByEdmId Delete an IP address whitelist

Request Parameters

Parameter

Type

Required

Description

Example

FromType

Integer

No

Abandoned, compatible with historical reasons

Abandoned, compatible with historical reasons

Id

String

No

The ID of the session.

10120

Action

String

Yes

The operation that you want to perform.

DeleteIpfilterByEdmId

For more information about other request parameters, see Common request parameters.

Response Parameters

Parameter

Type

Description

Example

RequestId

String

Request ID

E3DFF97B-00CF-5333-8125-3D6819471984

For more information about common response parameters, see Common response parameters.