SSL Certificates
- Announcements
- Product Introduction
- SSL Certificate Security
- Purchase Guide
- SSL Certificate Selection
- SSL Certificate Renewal Process
- Certificate Application
- Information Submission Process for Paid SSL Certificates
- Domain Ownership Validation
- Certificate Installation
- Installing an SSL Certificate on a Tencent Cloud Service
- Installation of International Standard Certificates
- Certificate Management
- API Documentation
- Making API Requests
- Certificate APIs
- Practical Tutorial
- Profile Management
- Troubleshooting
- FAQs
- SSL Certificate Selection
- SSL Certificate Application
- SSL Certificate Management
- SSL Certificate Installation
- SSL Certificate Region
- SSL Certificate Review
- SSL Certificate Taking Effect
- SSL Certificate Billing and Purchase
- Related Agreement
DescribeHostTeoInstanceList
Last updated: 2025-02-27 16:22:00
1. API Description
Domain name for API request: ssl.intl.tencentcloudapi.com.
This API is used to query the list of EdgeOne instances to which a certificate can be deployed.
A maximum of 10 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: DescribeHostTeoInstanceList. |
| Version | Yes | String | Common Params. The value used for this API: 2019-12-05. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| CertificateId | Yes | String | The ID of the certificate to be deployed. |
| IsCache | No | Integer | Whether to query the cached results. Valid values: 1 (yes) and 0 (no). By default, the cached results within 30 minutes are queried. |
| Filters.N | No | Array of Filter | The list of filter parameters. FilterKey: domainMatch (query the list of instances with matching or non-matching domains). FilterValue: 1 (default; query the list of instances with matching domains) or 0 (query the list of instances with non-matching domains). |
| OldCertificateId | No | String | The ID of the deployed certificate. |
| Offset | No | Integer | Paging offset. default value: 0. |
| Limit | No | Integer | Number of items per page. default: 10. maximum value: 200. |
| AsyncCache | No | Integer | Asynchronous or not. 1 means yes, 0 means no. default: 0. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| InstanceList | Array of TeoInstanceDetail | Teo instance list. if no value is obtained, an empty array is returned. Note: this field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The total count. |
| 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 Obtain the EdgeOne Instance List
Obtain the EdgeOne gateway instance list
Input Example
POST / HTTP/1.1
Host: ssl.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHostTeoInstanceList
<Common request parameters>
{
"CertificateId": "YT****j",
"IsCache": 1,
"Filters": [
{
"FilterKey": "domainMatch",
"FilterValue": "1"
}
],
"ResourceType": "teo",
"OldCertificateId": "k****j"
}
Output Example
{
"Response": {
"InstanceList": [
{
"Host": "www.zrh.com",
"CertId": "jk****L",
"ZoneId": "zone-*****",
"Status": "online"
}
],
"TotalCount": 1,
"RequestId": "14727a68-3b90-4408-99c9-dea6d7de9456"
}
}
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 |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.AuthError | You do not have permission to perform this operation. |
| FailedOperation.CertificateHostResourceInnerInterrupt | Unable to use the deployment feature because the login account is an internal account with too many instance resources. Please contact us to handle it. |
| FailedOperation.CertificateNotAvailable | The certificate is not available. Please check and try again. |
| FailedOperation.CertificateNotFound | The certificate does not exist. |
| FailedOperation.InvalidParam | Incorrect parameters. |
| FailedOperation.NoProjectPermission | You do not have the permission to operate on this project. |
| FailedOperation.NoRealNameAuth | You have not completed the identity verification. |
| FailedOperation.RoleNotFoundAuthorization | The role does not exist. Please authorize the role first. |
| InternalError | Internal error. |
| LimitExceeded.RateLimitExceeded | The API rate limit is reached. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No