调用 DescribeCertificates 接口，查询服务器证书列表。 ## 使用说明 * 单个账号每次最多查询100个证书。 * 每秒最多提交 40 个 API 请求。 ## 调试 ## 请求参数 **Action** `String` %%require%% 示例值：`DescribeCertificates` 接口名称。当前 API 的名称为 `DescribeCertificates`。 **Version** `String` %%require%% 示例值：`2020-04-01` 接口版本。当前 API 的版本为 `2020-04-01`。 **CertificateIds.N** `String[]` `可选` 示例值：`CertificateIds.1=cert-123*** 765&CertificateIds.2=cert-234****876` 证书的ID。 * 参数\- N：表示证书的序号，取值范围为1 ～ 100。 * 多个证书间使用“&”分隔。 **CertificateName** `String` `可选` 示例值：`test` 证书的名称。 **PageSize** `Integer` `可选` 示例值：`20` 分页查询时每页的行数，取值1\-100，默认为10。 **PageNumber** `Integer` `可选` 示例值：`1` 列表的页码，默认值为1。 **ProjectName** `String` `可选` 示例值：`default` 证书所属项目名称。 **TagFilters.N.Key** `String[]` `可选` 示例值：`TagFilters.1.Key=k1&TagFilters.2.Key=k2` 标签的标签键。 * 参数 \- N：表示标签键的序号，取值范围：1～10。 * 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的证书。 * 不允许重复。 **TagFilters.N.Values.N** `String[]` `可选` 示例值：`TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3` 标签的标签值。 * 第一个N：表示标签键的序号，取值范围：1～10。 * 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的证书。 * 多个标签值之间用&分隔。 :::tip 若传入该参数，则必须先传入TagFilters.N.Key。传入空字符串时，表示查询标签值为空的证书。 ::: ## 返回参数 **RequestId** `String` `可选` 示例值：`20210816110638****2514606306AF947C` 请求ID。 **PageSize** `Integer` `可选` 示例值：`20` 当前分页的行数。 **PageNumber** `Integer` `可选` 示例值：`1` 当前页码。 **TotalCount** `Integer` `可选` 示例值：`50` 符合条件的证书总数。 **Certificates** `Object[]` `可选` 示例值：`-` 符合条件的证书列表。 **CertificateId** `String` `可选` 示例值：`cert-123***765` 证书ID。 **CertificateName** `String` `可选` 示例值：`test` 证书名称。 **CertificateType** `String` `可选` 示例值：`server` 证书类型。 * Server：服务器证书。 **Description** `String` `可选` 示例值：`test` 证书描述。 **CreateTime** `String` `可选` 示例值：`2021-12-14T11:13:40+08:00` 证书的创建时间。 **ExpiredAt** `String` `可选` 示例值：`2021-12-14T11:13:40+08:00` 证书的过期时间。 **DomainName** `String` `可选` 示例值：`test.com` 证书的域名。 **San** `String` `可选` 示例值：`www.test.com,*.test.com` 证书的扩展域名列表，英文',' 分隔，包含(commonName,DnsName,IP) 。 **Listeners** `String[]` `可选` 示例值：`[lsn-123 *****112,lsn-234 *****567]` 证书关联的监听器列表。 **Status** `String` `可选` 示例值：`Active` 证书的状态。 * Creating：创建中。 * Active：运行中。 * Deleting：删除中。 **ProjectName** `String` `可选` 示例值：`default` 证书所属项目名称。 **Tags** `Object[]` `可选` 示例值：`-` 证书关联的标签。 **Key** `String` `可选` 示例值：`key` 用户标签的标签键。 **Value** `String` `可选` 示例值：`value` 用户标签的标签键。 ## 请求示例 ```JSON GET /?Action=DescribeCertificates&CertificateIds.1=cert-2fe5jqh****hs5oxruwk7x9ze&Version=2020-04-01 HTTP/1.1 Host: alb.cn-beijing.volcengineapi.com X-Date: 20251121T094038Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f ``` ## 返回示例 ```JSON { "ResponseMetadata": { "RequestId": "20210816110638****2514606306AF947C", "Action": "DescribeCertificates", "Version": "2020-04-01", "Service": "alb", "Region": "cn-beijing" }, "Result": { "RequestId": "20210816110638****2514606306AF947C", "PageNumber": 1, "PageSize": 10, "TotalCount": 1, "Certificates": [ { "CertificateId": "cert-2fe5k****c16o5oxruvtk3qf5", "CertificateName": "test", "CertificateType": "server", "Description": "test", "CreateTime": "2021-12-14T11:13:40+08:00", "ExpiredAt": "2021-12-14T11:13:40+08:00", "DomainName": "*.a.cdn-build.net", "Listeners": [ "lsn-1g0e0p14****88ibuxxpnwden", "lsn-1g0e0p90e****8ibuxwy36kc1" ] } ] } } ``` ## 错误码如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见[公共错误码](https://www.volcengine.com/docs/6406/113579)。 |**状态码** |**错误码** |**错误信息** |**说明** | |---|---|---|---| |400 |LimitExceed.ServerCertificate |You've reached the limit on the number of server certificates that you can operate at a time. |已达到单次可操作的服务器证书的数量上限。 | |400 |InvalidPaging.Malformed |The specified PageNumber or PageSize is malformed. |指定的分页参数格式不合法。 | |400 |InvalidCertificateName.Malformed |The specified CertificateName is malformed. |指定的 CertificateName 参数格式不合法。 | |400 |LimitExceed.TagFilters.Values |You've reached the limit on the number of tag filter values that you can operate at a time. |已达到单次可操作的标签值的数量上限。 | |400 |InvalidTagFilters.Key.Malformed |The specified TagFilters.Key is malformed. |指定的 TagFilters.Key 参数格式不合法。 | |400 |InvalidTagFilters.Value.Malformed |The specified TagFilters.Value is malformed. |指定的 TagFilters.Value 参数格式不合法。 | |400 |InvalidTagFilters.Key.Duplicated |The specified TagFilters.Key is duplicated. |指定的 TagFilters.Key 重复。 |