首页 边缘安全加速 边缘安全加速 ESA 开发参考 API参考 API目录 站点配置 规则配置 HTTPS规则 ListHttpsApplicationConfigurations - 查询HTTPS应用配置列表

ListHttpsApplicationConfigurations - 查询HTTPS应用配置列表

更新时间: 2025-03-18 17:23:50

查询多条HTTPS应用配置。

调试

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

授权信息

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

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

请求参数

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

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

123456****
ConfigIdlong

配置 ID。

3528160969****
ConfigTypestring

配置类型,可以根据此参数查全局配置或者规则配置,取值范围:

  • global:查询全局配置。
  • rule:查询规则配置。

该参数可以不传,不传时不区分全局或者规则配置。

global
RuleNamestring

规则名,可以查出规则名为所传字段的那条规则。

rule_example
PageNumberinteger

第几页,不传时默认为 1。

1
PageSizeinteger

每页几条,最大 500,不传时默认 500。

20
SiteVersioninteger

站点的版本号。开启了版本管理的站点,可以通过该参数指定配置生效的站点版本,默认为版本 0。

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

0AEDAF20-4DDF-4165-8750-47FF9C1929C9
Configsarray<object>

返回体配置。

configsobject
ConfigIdlong

配置 ID。

395386449776640
SiteVersioninteger

站点配置的版本号。开启了配置版本管理的站点,可以通过该参数指定配置生效的站点版本,默认为版本 0。

1
Sequenceinteger

规则执行顺序。数值越小越优先执行。

1
RuleEnablestring

规则开关。添加全局配置的时候不需要设置该参数。取值范围:

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

规则内容,使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景:

  • 匹配所有传入请求:值设置为 true
  • 匹配指定请求:值设置为自定义表达式,例如:(http.host eq "video.example.com")
(http.host eq \"video.example.com\")
RuleNamestring

规则名称。添加全局配置的时候不需要设置该参数。

rule_example
ConfigTypestring

配置类型,可以根据此参数查全局配置或者规则配置,取值范围:

  • global:查询全局配置。
  • rule:查询规则配置。
global
HttpsForcestring

是否开启强制 HTTPS,默认关闭。取值范围:

  • on:开启。

  • off:关闭。

on
HttpsForceCodestring

强制 HTTPS 跳转状态码,取值范围:

  • 301
  • 302
  • 307
  • 308
301
AltSvcstring

Alt-Svc 功能开关,默认关闭。取值范围:

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

Alt-Svc 头是否包含 clear 参数,默认关闭。取值:

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

Alt-Svc 头包是否含 persist 参数,默认关闭。取值:

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

Alt-Svc 有效时间,单位是秒,默认为 86400 秒。

86400
Hstsstring

是否开启 HSTS,默认关闭。取值范围:

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

HSTS 过期时间,单位是秒。

3600
HstsIncludeSubdomainsstring

是否在 HSTS 中包括子域,默认关闭。取值范围:

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

是否开启 HSTS 预加载,默认关闭。取值范围:

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

当前页码。

1
PageSizeinteger

分页大小。

10
TotalCountinteger

记录总数。

16
TotalPageinteger

总页数。

2

示例

正常返回示例

JSON格式

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "Configs": [
    {
      "ConfigId": 395386449776640,
      "SiteVersion": 1,
      "Sequence": 1,
      "RuleEnable": "on",
      "Rule": "(http.host eq \\\"video.example.com\\\")\n",
      "RuleName": "rule_example",
      "ConfigType": "global",
      "HttpsForce": "on",
      "HttpsForceCode": "301",
      "AltSvc": "on",
      "AltSvcClear": "on",
      "AltSvcPersist": "on",
      "AltSvcMa": "86400",
      "Hsts": "on",
      "HstsMaxAge": "3600",
      "HstsIncludeSubdomains": "on",
      "HstsPreload": "on"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 16,
  "TotalPage": 2
}

错误码

HTTP status code错误码错误信息描述
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
400InvalidParameter.FunctionNameThe specified feature does not exist. Specify a valid feature name based on the related documentation.您所输入的功能名称不存在,请参照功能配置文档选择正确的功能名进行操作。

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

上一篇: UpdateHttpsApplicationConfiguration - 修改站点HTTPS应用配置 下一篇: GetHttpsApplicationConfiguration - 查询站点HTTPS应用配置