DescribeHostsSetting
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to query detailed domain name configuration.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeHostsSetting. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | The site ID. |
| Offset | No | Integer | Offset for paginated queries. Default value: 0. Minimum value: 0. |
| Limit | No | Integer | Limit on paginated queries. Default value: 100. Maximum value: 1000. |
| Filters.N | No | Array of Filter | Filter conditions. The maximum value for Filters.Values is 20. The detailed conditions are as follows: |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| DetailHosts | Array of DetailHost | List of domain names. |
| TotalNumber | Integer | Number of domain names |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Query detailed configurations of the domain name
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHostsSetting
<Common request parameters>
{
"ZoneId": "zone-27q0p0bali16"
}
Output Example
{
"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": "abc"
},
"NoCache": {
"Switch": "on"
},
"FollowOrigin": {
"Switch": "on",
"DefaultCacheTime": 0,
"DefaultCache": "abc",
"DefaultCacheStrategy": "abc"
}
},
"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": "abc",
"CipherSuite": "abc"
},
"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. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| InternalError.RouteError | The backend routing address is incorrect. |
| InvalidParameter | Parameter error. |
| OperationDenied | Operation denied. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |