All Products
Search
Document Center

Edge Security Acceleration:GetPageShield

Last Updated:Jul 16, 2026

Queries the page protection configuration of a site.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

SiteId

integer

Yes

The site ID. You can obtain the ID by calling ListSites.

123456****

SiteVersion

integer

No

The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.

0

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

F32C57AA-7BF8-49AE-A2CC-9F42390F5A19

Enable

string

The switch status. Valid values:

  • on: Enabled.

  • off: Disabled.

on

ReportUri

string

The report URI.

/test

SiteVersion

integer

The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.

0

Examples

Success response

JSON format

{
  "RequestId": "F32C57AA-7BF8-49AE-A2CC-9F42390F5A19",
  "Enable": "on",
  "ReportUri": "/test",
  "SiteVersion": 0
}

Error codes

HTTP status code

Error code

Error message

Description

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.