tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeHostsSetting

最后更新时间：2023-03-09 17:41:36

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-01-06.
Region No String Common Params. This parameter is not required for this API.
ZoneId Yes String Site ID
Offset No Integer Offset for paginated queries. Default value: 0
Limit No Integer Limit on paginated queries. Default value: 100. Maximum value: 1000.
Hosts.N No Array of String Specifies a domain name for the query

3. Output Parameters

Parameter Name Type Description
Hosts Array of DetailHost List of domain names
TotalNumber Integer Number of domain names
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the detailed domain name configuration

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHostsSetting
<Common request parameters>

{
    "ZoneId": "xx"
}

Output Example

{
    "Response": {
        "Hosts": [
            {
                "Status": "xx",
                "Host": "xx",
                "ZoneId": "xx",
                "AppId": 0
            }
        ],
        "RequestId": "xx",
        "TotalNumber": 0
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款