GetOriginProtection API Overview: IP Whitelist & Convergence Status - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries site origin protection configurations, including the origin protection switch, the origin convergence switch, whether the origin IP whitelist needs to be updated, and detailed information about the origin IP whitelist, including the current origin IP whitelist used by the site, the latest origin IP whitelist, and the differences between them.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:GetOriginProtection

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	Site ID. You can call the ListSites operation to obtain the site ID.	123456789****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
CurrentIPWhitelist	object	The current origin IP whitelist used by the site.
IPv4	array	The current origin IP whitelist used by the site, IPv4 addresses or CIDR blocks.
	string	IPv4 address or CIDR block.	101.66.250.0/25
IPv6	array	The current origin IP whitelist used by the site, IPv6 addresses or CIDR blocks.
	string	IPv6 address or CIDR block.	2409:8c54:1841:200a::/64
LatestIPWhitelist	object	The latest origin IP whitelist.
IPv4	array	The latest origin IP whitelist, IPv4 addresses or CIDR blocks.
	string	IPv4 address or CIDR block.	101.66.250.0/25
IPv6	array	The latest origin IP whitelist, IPv6 addresses or CIDR blocks.
	string	IPv6 address or CIDR block.	2409:8c54:1841:200a::/64
DiffIPWhitelist	object	The changed origin IP whitelist.
AddedIPWhitelist	object	The added origin IP whitelist entries.
IPv4	array	The IPv4 addresses or CIDR blocks in the back-to-origin IP address whitelist.
	string	An IPv4 address or CIDR block.	101.66.250.0/25
IPv6	array	The IPv6 addresses or CIDR blocks in the back-to-origin IP address whitelist.
	string	An IPv6 address or CIDR block.	2409:8c54:1841:200a::/64
NoChangeIpWhitelist	object	The unchanged origin IP whitelist entries.
IPv4	array	The IPv4 addresses or CIDR blocks in the back-to-origin IP address whitelist.
	string	An IPv4 address or CIDR block.	101.66.250.0/25
IPv6	array	The IPv6 addresses or CIDR blocks in the back-to-origin IP address whitelist.
	string	An IPv6 address or CIDR block.	2409:8c54:1841:200a::/64
RemovedIPWhitelist	object	The removed origin IP whitelist entries.
IPv4	array	The IPv4 addresses or CIDR blocks in the back-to-origin IP address whitelist.
	string	An IPv4 address or CIDR block.	101.66.250.0/25
IPv6	array	The IPv6 addresses or CIDR blocks in the back-to-origin IP address whitelist.
	string	An IPv6 address or CIDR block.	2409:8c54:1841:200a::/64
RegionalCurrentIPWhitelist	object	The regional origin IP whitelist currently used by the site.
RegionalIPv4	array<object>	The regional origin IP whitelist currently used by the site, IPv4 CIDR blocks and regions.
	object	IPv4 CIDR block and region.
Cidr	string	The IPv4 CIDR block.	101.66.250.0/25
Region	string	The IPv4 region.	chinese_mainland
RegionalIPv6	array<object>	The regional origin IP whitelist currently used by the site, IPv6 CIDR blocks and regions.
	object	IPv6 CIDR block and region.
Cidr	string	The IPv6 CIDR block.	101.66.250.0/25
Region	string	The IPv6 region.	chinese_mainland
RegionalLatestIPWhitelist	object	The latest regional origin IP whitelist.
RegionalIPv4	array<object>	The latest regional origin IP whitelist, IPv4 CIDR blocks and regions.
	object	IPv4 CIDR block and region.
Cidr	string	The IPv4 CIDR block.	101.66.250.0/25
Region	string	The IPv4 region.	chinese_mainland
RegionalIPv6	array<object>	The latest regional origin IP whitelist, IPv6 CIDR blocks and regions.
	object	IPv6 CIDR block and region.
Cidr	string	The IPv6 CIDR block.	101.66.250.0/25
Region	string	The IPv6 region.	chinese_mainland
RegionalDiffIPWhitelist	object	The changed regional origin IP whitelist.
AddedIPRegionWhitelist	object	The added regional origin IP whitelist entries.
RegionalIPv4	array<object>	The IPv4 CIDR blocks and regions in the regional back-to-origin IP address whitelist.
	object	An IPv4 CIDR block and region.
Cidr	string	The IPv4 CIDR block.	101.66.250.0/25
Region	string	The IPv4 region.	chinese_mainland
RegionalIPv6	array<object>	The IPv6 CIDR blocks and regions in the regional back-to-origin IP address whitelist.
	object	An IPv6 CIDR block and region.
Cidr	string	The IPv6 CIDR block.	101.66.250.0/25
Region	string	The IPv6 region.	chinese_mainland
NoChangeIpWhitelist	object	The unchanged regional origin IP whitelist entries.
RegionalIPv4	array<object>	The IPv4 CIDR blocks and regions in the regional back-to-origin IP address whitelist.
	object	An IPv4 CIDR block and region.
Cidr	string	The IPv4 CIDR block.	101.66.250.0/25
Region	string	The IPv4 region.	chinese_mainland
RegionalIPv6	array<object>	The IPv6 CIDR blocks and regions in the regional back-to-origin IP address whitelist.
	object	An IPv6 CIDR block and region.
Cidr	string	The IPv6 CIDR block.	101.66.250.0/25
Region	string	The IPv6 region.	chinese_mainland
RemovedIPRegionWhitelist	object	The removed regional origin IP whitelist entries.
RegionalIPv4	array<object>	The IPv4 CIDR blocks and regions in the regional back-to-origin IP address whitelist.
	object	An IPv4 CIDR block and region.
Cidr	string	The IPv4 CIDR block.	101.66.250.0/25
Region	string	The IPv4 region.	chinese_mainland
RegionalIPv6	array<object>	The IPv6 CIDR blocks and regions in the regional back-to-origin IP address whitelist.
	object	An IPv6 CIDR block and region.
Cidr	string	The IPv6 CIDR block.	101.66.250.0/25
Region	string	The IPv6 region. Valid values: global_excluding_chinese_mainland : Global (Excluding the Chinese Mainland) chinese_mainland : Chinese Mainland	chinese_mainland
NeedUpdate	boolean	Indicates whether the origin IP whitelist needs to be updated. When the current origin IP whitelist differs from the latest origin IP whitelist, an update is needed and this value returns true. true: Update is needed. false: No update is needed.	true
OriginProtection	string	Origin protection switch: on: Enabled. off: Disabled.	on
OriginConverge	string	Origin convergence switch: on: Enabled. off: Disabled.	on
SiteId	integer	Site ID.	123456****
AutoConfirmIPList	string	Automatically enable the latest origin IP list.	off

Examples

Success response

JSON format

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE",
  "CurrentIPWhitelist": {
    "IPv4": [
      "101.66.250.0/25"
    ],
    "IPv6": [
      "2409:8c54:1841:200a::/64"
    ]
  },
  "LatestIPWhitelist": {
    "IPv4": [
      "101.66.250.0/25"
    ],
    "IPv6": [
      "2409:8c54:1841:200a::/64"
    ]
  },
  "DiffIPWhitelist": {
    "AddedIPWhitelist": {
      "IPv4": [
        "101.66.250.0/25"
      ],
      "IPv6": [
        "2409:8c54:1841:200a::/64"
      ]
    },
    "NoChangeIpWhitelist": {
      "IPv4": [
        "101.66.250.0/25"
      ],
      "IPv6": [
        "2409:8c54:1841:200a::/64"
      ]
    },
    "RemovedIPWhitelist": {
      "IPv4": [
        "101.66.250.0/25"
      ],
      "IPv6": [
        "2409:8c54:1841:200a::/64"
      ]
    }
  },
  "RegionalCurrentIPWhitelist": {
    "RegionalIPv4": [
      {
        "Cidr": "101.66.250.0/25",
        "Region": "chinese_mainland"
      }
    ],
    "RegionalIPv6": [
      {
        "Cidr": "101.66.250.0/25",
        "Region": "chinese_mainland"
      }
    ]
  },
  "RegionalLatestIPWhitelist": {
    "RegionalIPv4": [
      {
        "Cidr": "101.66.250.0/25",
        "Region": "chinese_mainland"
      }
    ],
    "RegionalIPv6": [
      {
        "Cidr": "101.66.250.0/25",
        "Region": "chinese_mainland"
      }
    ]
  },
  "RegionalDiffIPWhitelist": {
    "AddedIPRegionWhitelist": {
      "RegionalIPv4": [
        {
          "Cidr": "101.66.250.0/25",
          "Region": "chinese_mainland"
        }
      ],
      "RegionalIPv6": [
        {
          "Cidr": "101.66.250.0/25",
          "Region": "chinese_mainland"
        }
      ]
    },
    "NoChangeIpWhitelist": {
      "RegionalIPv4": [
        {
          "Cidr": "101.66.250.0/25",
          "Region": "chinese_mainland"
        }
      ],
      "RegionalIPv6": [
        {
          "Cidr": "101.66.250.0/25",
          "Region": "chinese_mainland"
        }
      ]
    },
    "RemovedIPRegionWhitelist": {
      "RegionalIPv4": [
        {
          "Cidr": "101.66.250.0/25",
          "Region": "chinese_mainland"
        }
      ],
      "RegionalIPv6": [
        {
          "Cidr": "101.66.250.0/25",
          "Region": "chinese_mainland"
        }
      ]
    }
  },
  "NeedUpdate": true,
  "OriginProtection": "on",
  "OriginConverge": "on",
  "SiteId": 0,
  "AutoConfirmIPList": "off"
}

Error codes

HTTP status code	Error code	Error message	Description
400	FunctionArgError	Failed to check the configured function parameters.	Failed to check the configured function parameters
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	InvalidParameter.Configs	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.	Invalid parameter configurations. Check whether your feature configurations are in the valid format and comply with relevant requirements.
404	SiteNotFound	The website does not exist or does not belong to you.	The website does not exist or does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.