DescribePageDocuments-阿里云帮助中心

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 single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

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

yundun-cloudfirewall:DescribePageDocuments

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	223.167.221.XXX
Lang	string	No	The language type. Valid values: en: English. zh: Chinese. Valid values: en : English. zh : Chinese.	zh
Lang	string	No	语言类型。 Valid values: en : 英文 zh : 中文	zh
SourceCode	string	Yes	The tracing code.	yundun
PageName	string	Yes	The page name. Valid values: overview: overview page access: access control page switch: firewall page. 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 image URL.	https://img.alicdn.com/tfs/TB1E4FCAuT2gK0jSZFvXXXnFXXa-3399-662.png
More	object	The list of additional resources.
Url	string	The document path.	https://zjysfy.womanhospital.cn/pub/hos/0/noneBackGround.png
Title	string	The title.	test
Docs	array<object>	The document list.
	object	The document list.
Url	string	The document path.	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.