DescribePageDocuments - 查看页面常见问题

查看页面常见问题。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

SourceIp

string

访问者源 IP

223.167.221.XXX

Lang

string

语言类型。

枚举值:

  • en :

    英文

  • zh :

    中文

zh

Lang

string

语言类型。

枚举值:

  • en :

    英文

  • zh :

    中文

zh

SourceCode

string

溯源码。

yundun

PageName

string

页面名称。

枚举值:

  • overview :

    概况页面

  • access :

    控制访问页面

  • switch :

    防火墙页面

overview

TabName

string

安全访问控制策略的防护对象名称。

internet

返回参数

名称

类型

描述

示例值

object

Module

string

应用模块。

sg_server

RequestId

string

请求 ID。

7C81E1AD-08C0-5E09-853B-FDC77B90****

ImageUrl

string

图片地址。

https://img.alicdn.com/tfs/TB1E4FCAuT2gK0jSZFvXXXnFXXa-3399-662.png

More

object

更多列表。

Url

string

文档路径。

https://zjysfy.womanhospital.cn/pub/hos/0/noneBackGround.png

Title

string

标题。

test

Docs

array<object>

文档列表。

object

文档列表。

Url

string

文档路径。

https://notify-center-test.ybaobx.com/webhook/arms

Title

string

标题。

test

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 ErrorSourceCodeError The source code is invalid. 无效的source code
400 ErrorDBSelectError A database select error occurred. 内部错误:数据库查询错误
400 ErrorMarshalJSON internal error. 内部错误。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情