文档中心>API 中心>SSL 证书>证书相关接口>查询证书CLB云资源部署实例列表信息

查询证书CLB云资源部署实例列表信息

最近更新时间:2024-03-12 01:48:00

我的收藏

1. 接口描述

接口请求域名: ssl.tencentcloudapi.com 。

查询证书clb云资源部署实例列表

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHostClbInstanceList。
Version String 公共参数,本接口取值:2019-12-05。
Region String 公共参数,本接口不需要传递此参数。
CertificateId String 待部署的证书ID
Offset Integer 分页偏移量,从0开始。
示例值:1
Limit Integer 每页数量,默认10。
示例值:10
IsCache Integer 是否查询缓存,1:是; 0:否, 默认为查询缓存,缓存半小时
Filters.N Array of Filter 过滤参数列表; FilterKey:domainMatch(查询域名是否匹配的实例列表) FilterValue:1,表示查询匹配; 0,表示查询不匹配; 默认查询匹配
AsyncCache Integer 是否异步缓存
OldCertificateId String 原证书ID

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
InstanceList Array of ClbInstanceDetail CLB实例监听器列表
注意:此字段可能返回 null,表示取不到有效值。
AsyncTotalNum Integer 异步刷新总数
注意:此字段可能返回 null,表示取不到有效值。
AsyncOffset Integer 异步刷新当前执行数
注意:此字段可能返回 null,表示取不到有效值。
AsyncCacheTime String 当前缓存读取时间
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询证书部署CLB实例列表

查询证书部署CLB实例列表

输入示例

POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHostClbInstanceList
<公共请求参数>

{
    "Offset": 1,
    "Limit": 1,
    "CertificateId": "abc",
    "IsCache": 1,
    "Filters": [
        {
            "FilterKey": "abc",
            "FilterValue": "abc"
        }
    ],
    "AsyncCache": 0,
    "OldCertificateId": "abc"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "InstanceList": [
            {
                "LoadBalancerId": "abc",
                "LoadBalancerName": "abc",
                "Listeners": [
                    {
                        "ListenerId": "abc",
                        "ListenerName": "abc",
                        "SniSwitch": 1,
                        "Protocol": "abc",
                        "Certificate": {
                            "CertId": "abc",
                            "DnsNames": [
                                "abc"
                            ]
                        },
                        "Rules": [
                            {
                                "LocationId": "abc",
                                "Domain": "abc",
                                "IsMatch": true,
                                "Certificate": {
                                    "CertId": "abc",
                                    "DnsNames": [
                                        "abc"
                                    ]
                                },
                                "NoMatchDomains": [
                                    "abc"
                                ]
                            }
                        ],
                        "NoMatchDomains": [
                            "abc"
                        ]
                    }
                ]
            }
        ],
        "AsyncTotalNum": 0,
        "AsyncOffset": 0,
        "AsyncCacheTime": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.AuthError 请检查是否有权限。
FailedOperation.CertificateHostDeployCanNotAllow 当前证书不允许使用一键更新的功能。
FailedOperation.CertificateHostResourceInnerInterrupt 当前为内部账号,账号涉及实例资源较多,无法使用部署功能,请联系SSL证书特殊处理。
FailedOperation.CertificateHostResourceInstanceHugeLimit 当前账号下实例数量过多,无法正常加载,请您切换加载方式。切换后点击“刷新列表”等待一段时间后即可全部加载。
FailedOperation.CertificateNotAvailable 证书不可用,请检查后再试。
FailedOperation.CertificateNotFound 证书不存在。
FailedOperation.InvalidParam 参数有误。
FailedOperation.NoProjectPermission 您没有该项目的操作权限。
FailedOperation.NoRealNameAuth 尚未通过实名认证。
FailedOperation.RoleNotFoundAuthorization 角色不存在,请前往授权。
InternalError 内部错误。
LimitExceeded.RateLimitExceeded 单位时间内接口请求频率达到限制。