GetOriginProtection - 获取源站防护信息

查询站点源站防护相关配置,包括源站防护开关、回源收敛开关、是否需要更新回源IP白名单,以及回源IP白名单相关详细信息,包括现在站点所使用的回源IP白名单、最新的回源IP白名单以及两者之间的差异。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:GetOriginProtectionnone
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

名称类型必填描述示例值
SiteIdlong

站点 ID,可通过调用 ListSites 接口获取。

123456789****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
CurrentIPWhitelistobject

站点当前所使用的回源 IP 白名单。

IPv4array

站点当前所使用的回源 IP 白名单,IPv4 地址或网段。

CurrentIPWhitelistipv4string

IPv4 地址或网段。

101.66.250.0/25
IPv6array

站点当前所使用的回源 IP 白名单,IPv6 地址或网段。

CurrentIPWhitelistipv6string

IPv6 地址或网段。

2409:8c54:1841:200a::/64
LatestIPWhitelistobject

最新的回源 IP 白名单。

IPv4array

最新的回源 IP 白名单,IPv4 地址或网段。

LatestIPWhitelistipv4string

IPv4 地址或网段。

101.66.250.0/25
IPv6array

最新的回源 IP 白名单,IPv6 地址或网段。

LatestIPWhitelistipv6string

IPv6 地址或网段。

2409:8c54:1841:200a::/64
DiffIPWhitelistobject

有变化的回源 IP 白名单。

AddedIPWhitelistobject

新增的回源 IP 白名单。

IPv4array

回源 IP 白名单,IPv4 地址或网段。

AddedIPWhitelistipv4string

IPv4 地址或网段。

101.66.250.0/25
IPv6array

回源 IP 白名单,IPv6 地址或网段。

AddedIPWhitelistipv6string

IPv6 地址或网段。

2409:8c54:1841:200a::/64
NoChangeIpWhitelistobject

没有变化的回源 IP 白名单。

IPv4array

回源 IP 白名单,IPv4 地址或网段。

NoChangeIpWhitelistipv4string

IPv4 地址或网段。

101.66.250.0/25
IPv6array

回源 IP 白名单,IPv6 地址或网段。

NoChangeIpWhitelistipv6string

IPv6 地址或网段。

2409:8c54:1841:200a::/64
RemovedIPWhitelistobject

删除的回源 IP 白名单。

IPv4array

回源 IP 白名单,IPv4 地址或网段。

RemovedIPWhitelistipv4string

IPv4 地址或网段。

101.66.250.0/25
IPv6array

回源 IP 白名单,IPv6 地址或网段。

RemovedIPWhitelistipv6string

IPv6 地址或网段。

2409:8c54:1841:200a::/64
NeedUpdateboolean

回源 IP 白名单是否需要更新,当所使用的回源 IP 白名单和最新的回源 IP 白名单有差异时,就需要更新,此值返回 true。

  • true:需要更新。
  • false:不需要更新。
true
OriginProtectionstring

源站防护开关:

  • on:开启。
  • off:关闭。
on
OriginConvergestring

回源收敛开关:

  • on:开启。
  • off:关闭。
on
SiteIdlong

站点 ID。

123456****

示例

正常返回示例

JSON格式

{
  "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"
      ]
    }
  },
  "NeedUpdate": true,
  "OriginProtection": "on",
  "OriginConverge": "on",
  "SiteId": 0
}

错误码

HTTP status code错误码错误信息描述
404SiteNotFoundThe website does not exist or does not belong to you.站点不存在,或者不属于你。

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

变更历史

变更时间变更内容概要操作
2024-12-24OpenAPI 错误码发生变更查看变更详情