调用本接口获取SSL证书实例列表。

请求说明

请求频率：同一个租户每秒最多允许请求20次。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action string 必选示例值：CertificateGetInstanceList

要执行的操作，取值：CertificateGetInstanceList。

Version string 必选示例值：2024-10-01

API的版本，取值：2024-10-01。

Body

InstanceIds string[] 可选示例值：["cert-310a6640e2ef4c1dbe5065c62821****"]

指定证书实例的ID。

Status string[] 可选示例值：["Issued"]

指定证书实例的状态。证书状态有以下取值：

NotSubmitted：待提交申请

Pending：验证中

Issued：已签发

Cancelling：取消中

Canceled：已取消

Revoking：吊销中

Revoked：已吊销

Failed：申请失败

Unknown：未知

Tag string 可选示例值：未命名证书

指定证书实例的备注。支持模糊匹配。

CommonName string 可选示例值：example.com

指定证书的公用名称（CN）。支持模糊匹配。

Domain string 可选示例值：www.example.com

指定证书的主题备用名称（SAN）。支持模糊匹配。

InstanceType string 可选示例值：Free

指定证书实例的类型。该参数有以下取值：

Free：免费证书

Test：测试证书（付费）

Paid：正式证书（付费）

Imported：上传的证书

IsRevoked boolean 可选示例值：false

是否只返回已吊销的证书。默认值：false。

IsValid boolean 可选示例值：true

是否只返回有效的证书。默认值：false。

有效的证书表示证书已签发，在有效期内，并且没有被吊销。

CertificateExpireBefore string 可选示例值：2024-11-24 07:59:59

指定证书过期时间的结束时间。格式为：yyyy-mm-dd hh:mm:ss。

CertificateExpireAfter string 可选示例值：2024-10-25 08:00:00

指定证书过期时间的开始时间。时间格式为：yyyy-mm-dd hh:mm:ss。

PageNumber integer 可选示例值：1

设置要返回的页码。默认值：1。

PageSize integer 可选示例值：10

设置单页包含的最大证书实例数。默认值：10。最大值：100。

ProjectName string 可选示例值：default

指定证书实例所属火山引擎项目的名称。

TagFilters object[] 可选示例值：

指定证书实例绑定的资源标签列表。

Key string 必选示例值：env

标签键。

Values string[] 必选示例值：test

标签值。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PageNumber integer 示例值：1

当前页码。

PageSize integer 示例值：10

单页包含的最大证书实例数。

TotalCount integer 示例值：1

符合查询条件的证书实例数。

Instances object[] 示例值：

证书实例对象列表。

AccountId string 示例值：210000XXXX

火山引擎账号ID。

SourceId string 示例值：cert-6d580ffd930e42239dad01b56654****

适用于通过续费获得的证书，表示被续费的旧证书实例的ID。

Tag string 示例值：未命名证书

证书实例的备注。

Status string 示例值：Issued

证书实例的状态。该参数有以下取值：

NotSubmitted：待提交申请

Pending：验证中

Issued：已签发

Cancelling：取消中

Canceled：已取消

Revoking：吊销中

Revoked：已吊销

Failed：申请失败

Unknown：未知

InstanceType string 示例值：Paid

证书实例的类型。该参数有以下取值：

Free：免费证书

Test：测试证书（付费）

Paid：正式证书（付费）

Imported：上传的证书

InstanceId string 示例值：cert-c88df6d4a1b348c3b714b746d3cc****

证书实例ID。

CommonName string 示例值：*.example.com

证书的公用名（CN）。

Issuer string 示例值：RapidSSL TLS RSA CA G1

证书签发者的公用名（CN）。

San string[] 示例值：*.example.com

证书的主题备用名称（SAN）。主题备用名称包含证书可保护的所有域名。

IsCertificateRevoked boolean 示例值：false

证书是否已吊销。

IsCertificateSm boolean 示例值：false

证书是否是国密证书。

OrderPeriod integer 示例值：12

证书服务的时长。单位：月。

对于上传的证书，该参数的值为 0。

OrderBrand string 示例值：digicert_free

证书的品牌。

对于上传的证书，该参数的值为空。

InstanceLevel string 示例值：dv

证书的类型。该参数有以下取值：

dv：域名验证

ov：组织验证

ev：扩展验证

对于上传的证书，该参数的值为空。

CertificateDomainType string 示例值：Wildcard

证书的域名类型。该参数有以下取值：

Single：单域名

Wildcard：泛域名

Multi：混合多域名

对于上传的证书，该参数的值为空。

CertificateKeyAlgorithm string 示例值：RSA 2048

证书的密钥算法。

NotBefore string 示例值：2024-12-26 08:00:00

证书有效期的开始时间。

NotAfter string 示例值：2025-01-25 07:59:59

证书有效期的结束时间。

ProjectName string 示例值：default

证书实例所属火山引擎项目的名称。

Tags object[] 示例值：

证书实例绑定的资源标签列表。

Key string 示例值：env

标签键。

Value string 示例值：test

标签值。

CreatedTime string 示例值：2024-12-26 19:15:11

证书实例的创建时间。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MalformedRequest	The request is malformed	请求参数格式不合法。
400	InvalidParameter	The specified parameter %s is invalid.	指定的参数值无效。
400	MissingParameter	The required parameter %s is missing.	缺少必填参数。
500	InternalError	The request has failed due to an unknown error.	未知错误。

证书中心