DescribeHostsCertificate

Last updated: 2023-03-09 17:41:56

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

This API is used to query certificates of domain names. Paging, sorting and filtering are supported.

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: DescribeHostsCertificate.
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	ID of the site
Offset	No	Integer	Offset for paginated queries. Default value: 0
Limit	No	Integer	Limit on paginated queries. Default value: 100. Maximum value: 1000.
Filters.N	No	Array of CertFilter	Query filter
Sort	No	CertSort	Sorting order

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Used for paginated query by total count
Hosts	Array of HostCertSetting	List of certificate configurations for domain names Note: This field may return `null`, indicating that no valid value can be obtained.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying certificates of domain names

Input Example

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

{
    "ZoneId": "xx",
    "Limit": 100,
    "Offset": 0
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "Hosts": [
            {
                "Host": "www.test,com",
                "CertInfo": [
                    {
                        "CertId": "xxxx",
                        "Type": "default",
                        "Alias": "xxxx",
                        "ExpireTime": "2014-08-03T12:00:00+08:00",
                        "DeployTime": "2014-08-03T12:00:00+08:00"
                    }
                ]
            }
        ],
        "RequestId": "xxxx-xxxx-xxxx"
    }
}

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

Tencent Cloud CLI 3.0

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.
InternalError.SystemError	Internal system error.
InvalidParameter.InvalidFilterName	Invalid filter field.
OperationDenied	Operation denied.
UnauthorizedOperation.NoPermission	The sub-account is not authorized for the operation. Please get permissions first.

tencent cloud

Recent Pages