1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口为旧版,EdgeOne 已对规则引擎相关接口全面升级,可通过 DescribeL7AccSetting 和 DescribeL7AccRules 来获取域名的详细配置。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeHostsSetting。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneId | 是 | String | 站点ID。 |
Offset | 否 | Integer | 分页查询偏移量。默认值: 0,最小值:0。 |
Limit | 否 | Integer | 分页查询限制数目。默认值: 100,最大值:1000。 |
Filters.N | 否 | Array of Filter | 过滤条件,Filters.Values的上限为20。详细的过滤条件如下: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DetailHosts | Array of DetailHost | 域名列表。 |
TotalNumber | Integer | 域名数量。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询域名详细配置
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHostsSetting
<公共请求参数>
{
"ZoneId": "zone-27q0p0bali16"
}
输出示例
{
"Response": {
"DetailHosts": [
{
"Status": "online",
"Host": "test.example.com",
"ZoneId": "zone-27q0p0bali16",
"ZoneName": "example.com",
"Cname": "test.example.com.acc.edgeonedy1.com.",
"Id": "edge-ja6yyfjh",
"InstanceId": "edge-ja6yyfjh",
"Lock": 0,
"Mode": 0,
"Area": "mainland",
"AccelerateType": {
"Switch": "on"
},
"CacheConfig": {
"Cache": {
"Switch": "on",
"CacheTime": 0,
"IgnoreCacheControl": "off"
},
"NoCache": {
"Switch": "on"
},
"FollowOrigin": {
"Switch": "on",
"DefaultCacheTime": 0,
"DefaultCache": "on",
"DefaultCacheStrategy": "on"
}
},
"CacheKey": {
"FullUrlCache": "on",
"IgnoreCase": "off",
"QueryString": {
"Action": "includeCustom",
"Switch": "off",
"Value": []
}
},
"Compression": {
"Algorithms": [
"brotli",
"gzip"
],
"Switch": "on"
},
"DDoS": {
"Switch": "on"
},
"ClientIpCountry": {
"HeaderName": "",
"Switch": "off"
},
"CC": {
"PolicyId": 1996,
"Switch": "on"
},
"Waf": {
"PolicyId": 1995,
"Switch": "on"
},
"Https": {
"CertInfo": [],
"Hsts": {
"IncludeSubDomains": "off",
"MaxAge": 1,
"Preload": "off",
"Switch": "on"
},
"Http2": "on",
"OcspStapling": "off",
"TlsVersion": [
"TLSv1",
"TLSv1.1",
"TLSv1.2",
"TLSv1.3"
],
"ApplyType": "apply",
"CipherSuite": "loose-v2023"
},
"Ipv6": {
"Switch": "off"
},
"Origin": {
"BackupOrigins": [],
"CosPrivateAccess": "off",
"OriginPullProtocol": "follow",
"Origins": [
"1.1.1.1:80:100"
]
},
"SecurityType": {
"Switch": "on"
},
"SmartRouting": {
"Switch": "off"
}
}
],
"RequestId": "9cc50b24-7dc5-44f4-96ce-95825d53ff2f",
"TotalNumber": 1
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ProxyServer | 后端服务器发生未知错误。 |
InternalError.RouteError | 后端服务路由地址错误。 |
InvalidParameter | 参数错误。 |
OperationDenied | 操作被拒绝。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |
UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |