DescribePageDocuments - Cloud Firewall - Alibaba Cloud Documentation Center

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Operation description

QPS limit

The queries per second (QPS) limit for this operation is 10 for each user. If you exceed the limit, API calls are throttled. This can affect your business. Plan your calls accordingly.

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
SourceIp	string	No	The source IP address of the visitor.	223.167.221.XXX
Lang	string	No	The language. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language. Valid values: en : English zh : Chinese	zh
SourceCode	string	Yes	The tracing code for the source.	yundun
PageName	string	Yes	The page name. Valid values: overview : Overview page access : Access control page switch : Firewall page	overview
TabName	string	Yes	The name of the protected object in the access control policy.	internet

Response elements

Element	Type	Description	Example
	object
Module	string	The application module.	sg_server
RequestId	string	The request ID.	7C81E1AD-08C0-5E09-853B-FDC77B90****
ImageUrl	string	The URL of the image.	https://img.alicdn.com/tfs/TB1E4FCAuT2gK0jSZFvXXXnFXXa-3399-662.png
More	object	Additional information.
Url	string	The URL of the document.	https://zjysfy.womanhospital.cn/pub/hos/0/noneBackGround.png
Title	string	The title.	test
Docs	array<object>	The list of documents.
	object	The list of documents.
Url	string	The URL of the document.	https://notify-center-test.ybaobx.com/webhook/arms
Title	string	The title.	test

Examples

Success response

JSON format

{
  "Module": "sg_server",
  "RequestId": "7C81E1AD-08C0-5E09-853B-FDC77B90****",
  "ImageUrl": "https://img.alicdn.com/tfs/TB1E4FCAuT2gK0jSZFvXXXnFXXa-3399-662.png",
  "More": {
    "Url": "https://zjysfy.womanhospital.cn/pub/hos/0/noneBackGround.png",
    "Title": "test"
  },
  "Docs": [
    {
      "Url": "https://notify-center-test.ybaobx.com/webhook/arms",
      "Title": "test"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorSourceCodeError	The source code is invalid.	The source code is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorMarshalJSON	internal error.	Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.