查询多条HTTPS基础配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:ListHttpsBasicConfigurations |
list |
*Site
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SiteId |
integer |
是 |
站点 ID,可通过调用 ListSites 接口获取。 |
123456**** |
| ConfigId |
integer |
否 |
配置 ID。 |
35281609698**** |
| ConfigType |
string |
否 |
配置类型,可以根据此参数查全局配置或者规则配置,取值范围:
该参数可以不传,不传时不区分全局或者规则配置。 枚举值:
|
global |
| RuleName |
string |
否 |
规则名,可以查出规则名为所传字段的那条规则。 |
test |
| PageNumber |
integer |
否 |
分页查询时设置的页码。取值大于等于 1。 |
1 |
| PageSize |
integer |
否 |
分页查询时每页的大小,取值范围 1-500。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395 |
| Configs |
array<object> |
返回体配置。 |
|
|
object |
|||
| ConfigId |
integer |
配置 ID。 |
395386449776640 |
| Sequence |
integer |
规则执行顺序。数值越小越优先执行。 |
1 |
| RuleEnable |
string |
规则开关。添加全局配置的时候不需要设置该参数。取值范围:
|
on |
| Rule |
string |
规则内容,使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景:
|
(http.host eq \"video.example.com\") |
| RuleName |
string |
规则名称。添加全局配置的时候不需要设置该参数。 |
rule_example |
| ConfigType |
string |
配置类型,可以根据此参数查全局配置或者规则配置,取值范围:
|
global |
| Https |
string |
是否开启 HTTPS,默认开启。取值范围:
|
on |
| Tls10 |
string |
是否开启 TLS1.0,默认关闭。取值范围:
|
on |
| Tls11 |
string |
是否开启 TLS1.1,默认关闭。取值范围:
|
on |
| Tls12 |
string |
是否开启 TLS1.2,默认关闭。取值范围:
|
on |
| Tls13 |
string |
是否开启 TLS1.3,默认关闭。取值范围:
|
on |
| CiphersuiteGroup |
string |
加密套件组,默认使能全部加密套件。取值范围:
|
strict |
| Ciphersuite |
string |
自定义加密套件,表示当 CiphersuiteGroup 为 custom 时选取的具体加密算法。 |
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 |
| OcspStapling |
string |
是否开启 OCSP,默认关闭。取值范围:
|
on |
| Http2 |
string |
是否开启 HTTP2,默认开启。取值范围:
|
on |
| Http3 |
string |
是否开启 HTTP3,默认开启。取值范围:
|
on |
| PageNumber |
integer |
当前页码,同请求参数的 PageNumber。 |
1 |
| PageSize |
integer |
每页大小。 |
10 |
| TotalCount |
integer |
记录总数。 |
20 |
| TotalPage |
integer |
总页数。 |
2 |
示例
正常返回示例
JSON格式
{
"RequestId": "EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395",
"Configs": [
{
"ConfigId": 395386449776640,
"Sequence": 1,
"RuleEnable": "on",
"Rule": "(http.host eq \\\"video.example.com\\\")\n",
"RuleName": "rule_example",
"ConfigType": "global",
"Https": "on",
"Tls10": "on",
"Tls11": "on",
"Tls12": "on",
"Tls13": "on",
"CiphersuiteGroup": "strict",
"Ciphersuite": "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256",
"OcspStapling": "on",
"Http2": "on",
"Http3": "on"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 20,
"TotalPage": 2
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
| 400 | InvalidParameter.FunctionName | The specified feature does not exist. Specify a valid feature name based on the related documentation. | 您所输入的功能名称不存在,请参照功能配置文档选择正确的功能名进行操作。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。