支持通过实例或域名,查询对应的域名接入规则详情。
域名维度下可选择精确匹配或模糊匹配,在精确匹配模式下,您可以输入域名数组进行查询。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescHostRules | 要执行的操作,取值:DescHostRules。 |
Version | String | 是 | 2021-06-15 | API的版本,取值:2021-06-15。 |
Demension | Integer | 是 | 1 | 查询维度,按域名查询或按实例 IP 查询。
|
Accurate | Integer | 否 | 1 | 按域名查询时,需要设置匹配模式。
|
Host | String | 否 | www.test.com | 域名信息,按域名查询时需要填写。 |
Hosts | Array of String | 否 | www.test1.com,www.test2.com | 域名数组,适用于域名维度的精确匹配。 |
InstanceIp | String | 否 | 1.1.1.1 | 高防实例 IP,按实例查询时需要填写。 |
SearchName | String | 否 | www.test | 适用于实例维度查询,用域名辅助检索实例下的转发规则。 |
CurrPage | Integer | 否 | 1 | 当前展示的页码。 |
PageSize | Integer | 否 | 10 | 每个页面展示的条目数量。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Result | HostRuleResult | -- | 域名转发规则详情。 |
PageInfo | PageInfo | -- | 分页信息。 |
GET /?Action=DescHostRules&Version=2021-06-15&Demension=1&CurrPage=1&PageSize=20 HTTP/1.1 Host: https://open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20240514T080643Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240514/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f {}
{ "ResponseMetadata": { "RequestId": "20240514160803252097155006EE****", "Action": "DescHostRules", "Version": "2021-06-15", "Service": "AdvDefence", "Region": "cn-beijing" }, "Result": { "PageInfo": { "TotalCount": 1, "PageSize": 20, "CurrentPage": 1, "Count": 1 }, "RuleList": [ { "HostId": 2790, "Host": "pro.test.com", "DefIp": [ "45.120.103.***" ], "Labels": [], "Certificate": "cert12", "UserCertId": "cert-5ce57f81d29f420baa4348f6501f****", "LBAlgorithm": "wrr", "AccessMode": 1, "Protocols": [ "HTTPS" ], "Servers": [ { "Protocol": "HTTPS", "Port": 443, "Addr": "82.157.152.***", "Weight": 100, "Type": 1, "BackUp": 0 } ], "CcEnable": 1, "AllowEnable": 1, "BlockEnable": 1, "BlackLctEnable": 1, "Examined": 1, "Status": 0, "CertStatus": 1, "ErrMsg": "", "ProtoFollow": 0, "Http2": 0, "BackUpStatus": 0, "LastSwitchTime": 0, "DefaultType": "", "AllSSLCipher": 1, "SSLProtocols": [ "TLSv1.2", "TLSv1.3" ], "SSLCiphers": [], "KeepAliveTimeOut": 75, "KeepAliveRequests": 100, "ClientMaxBodySize": 60, "ProxySetHeader": null, "ProxyConnectTimeOut": 4, "ProxySendTimeOut": 60, "ProxyReadTimeOut": 60, "ProxyKeepAliveRequests": 100, "ProxyRetry": 3, "ProxyKeepAliveTimeOut": 15, "GzipMode": 2, "ChunkMode": 2 } ], "Count": 0, "RemainCount": 0 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | 1 | 请求内容/参数错误,请检查请求内容/参数格式。 |
|
200 | 2 | 内部错误,请重试或联系服务提供者。 | 服务操作失败。 |
200 | 10 | 内部错误,请重试或联系服务提供者。 | 状态异常。 |