最近更新时间：2024.03.19 10:22:16
首次发布时间：2021.08.31 10:37:28
调用 DescribeCertificates 接口查询证书列表。
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeCertificates | 要执行的操作，取值为DescribeCertificates。 |
| Version | String | 是 | 2020-04-01 | API版本信息，当前版本为：2020-04-01。 |
CertificateIds.N | String | 否 | CertificateIds.1=cert-3tjuxoukkq3vj0ww****&CertificateIds.2=cert-3tigvwjuzu3vj0wt**** | 证书ID。您可以调用本接口获取证书ID。
|
| CertificateName | String | 否 | mycert | 证书的名称。 |
| PageNumber | Integer | 否 | 1 | 列表的页码，默认值为1。 |
| PageSize | Integer | 否 | 10 | 分页查询时每页的行数，取值范围为1 ～ 100，默认值为10。 |
ProjectName | String | 否 | default | 证书所属项目的名称。
|
TagFilters.N.Key | String | 否 | TagFilters.1.Key=k1&TagFilters.2.Key=k2 | 根据标签查询资源时指定的标签键。
|
TagFilters.N.Values.M | String | 否 | TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3 | 资源标签的标签值。每个标签键最多可指定3个标签值。
|
| 字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 20210811152539010225146063030**** | 请求ID |
| PageSize | Integer | 20 | 当前分页的行数。 |
| PageNumber | Integer | 1 | 当前页码。 |
| TotalCount | Integer | 50 | 符合条件的证书总数。 |
| Certificates | Array of Struct | - | 符合条件的证书的详细信息。具体请参见“ Certificates ”。 |
| 字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CertificateId | String | cert-3tigvwjuzu3vj0wt**** | 证书的ID。 |
| CertificateName | String | mycert01 | 证书的名称。 |
| Description | String | This is a cert. | 证书的描述。 |
| CreateTime | String | 2021-08-11T16:37:37Z | 证书的创建时间。 |
| ExpiredAt | String | 2021-08-11T16:37:37Z | 证书的到期时间。 |
| DomainName | String | *.com | 证书的域名。 |
| Listeners | List of String | ["lsn-rrhsh4vegr9cv0x591p****","lsn-mioicx8e1jpc5smt1ayy****"] | 证书关联的监听器的ID。 |
| ProjectName | String | default | 证书所属项目的名称。 |
ServiceManaged | Boolean | false | 是否为托管资源。
|
| Tags | Array of Struct | - | 标签的详细信息。具体请参见“ Tags”。 |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | k1 | 标签键。 |
| Value | String | v1 | 标签值。 |
GET /?Action=DescribeCertificates&Version=2020-04-01&CertificateIds.1=cert-3tjuxoukkq3vj0ww**** HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing Service: clb
{ "ResponseMetadata": { "RequestId": "20210811152539010225146063030****", "Action": "DescribeCertificates", "Version": "2020-04-01", "Service": "clb", "Region": "cn-beijing" }, "Result": { "RequestId": "20210811152539010225146063030****", "PageNumber": 1, "PageSize": 10, "TotalCount": 1, "Certificates": [ { "CertificateId": "cert-3tjuxoukkq3vj0ww****", "CertificateName": "test", "Description": "test", "CreateTime": "2021-08-16T20:53:24Z", "ExpiredAt": "2021-08-16T07:59:59Z", "DomainName": "*.a.cdn-build.net", "Listeners": [ "lsn-rrhsh4vegr9cv0x591p****", "lsn-mioicx8e1jpc5smt1ayy****" ], "ProjectName": "default", "ServiceManaged": false, "Tags": [ { "Key": "k1", "Value": "v1" } ] } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidName.Malformed | The specified Name is malformed. | 指定的 Name 参数格式不合法。 |
| 400 | InvalidPaging.Malformed | The specified PageNumber or PageSize is malformed. | 指定的分页参数格式不合法。 |
| 400 | LimitExceeded.CertificateId | You've reached the limit on the number of Certificate that you can operate. | 已达到单次可操作证书的资源数量上限。 |
| 400 | InvalidIncorrectOrder.Malformed | The specified index order is malformed. | 指定的索引顺序参数格式不合法。 |
| 400 | InvalidTagKey.Malformed | The specified TagKey is malformed. | 指定的 TagKey 参数格式不合法。 |
| 400 | InvalidTagValue.Malformed | The specified TagValue is malformed. | 指定的 TagValue 参数格式不合法。 |
| 400 | LimitExceeded.TagFilterKey | You've reached the limit on the number of tag keys that you can filter. | 已达到单次可指定过滤标签键数量的上限。 |
| 400 | LimitExceeded.TagFilterValues | You've reached the limit on the number of tag values that you can filter. | 已达到单次可指定过滤标签键值数量的上限。 |