证书中心
证书中心
文档指南
请输入
- 文档首页
证书中心SSL证书API 参考（新版，推荐使用）证书实例CertificateGetInstance - 查询证书实例详情
复制全文
下载 pdfCertificateGetInstance - 查询证书实例详情
文档反馈
问问助手调用本接口查询指定SSL证书实例的详情。
请求说明
请求频率：同一个租户每秒最多允许请求20次。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
Action string 必选 示例值：CertificateGetInstance
要执行的操作，取值：CertificateGetInstance。
Version string 必选 示例值：2024-10-01
API的版本，取值：2024-10-01。
Body
InstanceId string 必选 示例值：cert-c88df6d4a1b348c3b714b746d3cc****
指定证书实例的ID。
返回参数
ValidationType string 示例值：dns_txt
域名所有权的验证方式。该参数有以下取值：
- dns_cname：DNS 验证（基于 CNAME 记录）
- dns_txt：DNS 验证（基于 TXT 记录）
- https：文件验证（基于 HTTPS 请求）
- http：文件验证（基于 HTTP 请求）
对于上传的证书，该参数的值为空。
MultiDomainInstanceConf object 示例值：{"StandardDomainNumber": 0, "WildcardDomainNumber": 0}
多域名证书配置信息。仅当证书为多域名类型（CertificateDomainType 为 Multi）时有意义。
> 对于上传的证书或非多域名证书，子字段值为 0。
StandardDomainNumber integer 示例值：0
多域名证书中包含的标准域名（单域名）数量。
WildcardDomainNumber integer 示例值：0
多域名证书中包含的泛域名数量。
InstanceId string 示例值：cert-c88df6d4a1b348c3b714b746d3cc****
证书实例ID。
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：上传的证书
InstanceLevel string 示例值：dv
证书的类型。该参数有以下取值：
- dv：域名验证
- ov：组织验证
- ev：扩展验证
对于上传的证书，该参数的值为空。
OrderBrand string 示例值：digicert
证书的品牌。
对于上传的证书，该参数的值为空。
OrderOrganizationId string 示例值：org-685e6a2bae5b46bcacbe3a82965e****
证书订单所关联信息模板的ID。
对于上传的证书，该参数的值为空。
OrderPeriod integer 示例值：12
证书服务的时长。单位：月。
对于上传的证书，该参数的值为 0。
OrderPlan string 示例值：digicert_wildcard_dv
证书的规格。
对于上传的证书，该参数的值为空。
CertificateDomainType string 示例值：Wildcard
证书的域名类型。该参数有以下取值：
- Single：单域名
- Wildcard：泛域名
- Multi：混合多域名
对于上传的证书，该参数的值为空。
IsCertificateSm boolean 示例值：false
证书是否是国密证书。
IsCertificateRevoked boolean 示例值：false
证书是否已吊销。
CommonName string 示例值：*.example.com
证书的公用名称（CN）。
San string[] 示例值：*.example.com
证书的主题备用名称（SAN）。主题备用名称包含证书可保护的所有域名。
NotBefore string 示例值：2024-12-26 08:00:00
证书有效期的开始时间。
NotAfter string 示例值：2025-01-25 07:59:59
证书有效期的结束时间。
CertificateDetail object 示例值：
证书详情。
Subject object 示例值：
证书的主题信息。
CommonName string 示例值：*.example.com
公用名称（CN）。
Organization string 示例值：测试企业
企业名称（O）。
OrganizationUnit string 示例值：系统部
部门（OU）。
Country string 示例值：CN
国家（C）。
Province string 示例值：Shanghai
省份或州（ST）。
Locality string 示例值：Shanghai
城市（L）。
Address string 示例值：某某街道某号
地址（Street）。
PostalCode string 示例值：310000
邮编（PostalCode）。
Issuer object 示例值：
证书的签发者信息。
CommonName string 示例值：*.example.com
公用名称（CN）。
Organization string 示例值：测试企业
企业名称（O）。
OrganizationUnit string 示例值：系统部
部门（OU）。
Country string 示例值：CN
国家（C）。
Province string 示例值：Shanghai
省份或州（ST）。
Locality string 示例值：Shanghai
城市（L）。
Address string 示例值：某某街道某号
地址（Street）。
PostalCode string 示例值：310000
邮编（PostalCode）。
Chain string[] 示例值：[
"-----BEGIN CERTIFICATE-----\nMIIEqzCC......mSD5gds=\n-----END CERTIFICATE-----\n",
"-----BEGIN CERTIFICATE-----\nMIIEszCC......../m8Fxw==\n-----END CERTIFICATE-----\n",
"-----BEGIN CERTIFICATE-----\nMIIDjjCC......fl\nMrY=\n-----END CERTIFICATE-----\n"
]``
证书链（PEM格式）。
证书链由叶子证书、中间根证书和根证书组成。
PrivateKey string 示例值：-----BEGIN RSA PRIVATE KEY-----\nMIIEogIB......vhUorDg=\n-----END RSA PRIVATE KEY-----\n``
私钥。
SerialNumber string 示例值：00000000089E14D489AC80161569F34A29D6CEA7
序列号。
KeyAlgorithm string 示例值：RSA 2048
密钥算法。
SignatureAlgorithm string 示例值：SHA256-RSA
签名算法。
FingerPrintSha256 string 示例值：A53B846E14B33939E6CD7F9CF320FD9F96AB1D466A224CD28A38DC1388F51248
SHA-256指纹。
FingerPrintSha1 string 示例值：AAB216FF78244113D199CB87A8FE62992DB56EF0
SHA-1指纹。
EncryptionCertificateDetail object 示例值：
仅适用于国密证书，表示加密证书详情。
Subject object 示例值：
证书的主题信息。
CommonName string 示例值：*.example.com
公用名称（CN）。
Organization string 示例值：测试企业
企业名称（O）。
OrganizationUnit string 示例值：系统部
部门（OU）。
Country string 示例值：CN
国家（C）。
Province string 示例值：Shanghai
省份或州（ST）。
Locality string 示例值：Shanghai
城市（L）。
Address string 示例值：某某街道某号
地址（Street）。
PostalCode string 示例值：310000
邮编（PostalCode）。
Issuer object 示例值：
证书的签发者信息。
CommonName string 示例值：*.example.com
公用名称（CN）。
Organization string 示例值：测试企业
企业名称（O）。
OrganizationUnit string 示例值：系统部
部门（OU）。
Country string 示例值：CN
国家（C）。
Province string 示例值：Shanghai
省份或州（ST）。
Locality string 示例值：Shanghai
城市（L）。
Address string 示例值：某某街道某号
地址（Street）。
PostalCode string 示例值：310000
邮编（PostalCode）。
Chain string[] 示例值：[
"-----BEGIN CERTIFICATE-----\nMIIEqzCC......mSD5gds=\n-----END CERTIFICATE-----\n",
"-----BEGIN CERTIFICATE-----\nMIIEszCC......../m8Fxw==\n-----END CERTIFICATE-----\n",
"-----BEGIN CERTIFICATE-----\nMIIDjjCC......fl\nMrY=\n-----END CERTIFICATE-----\n"
]``
证书链（PEM格式）。
证书链由叶子证书、中间根证书和根证书组成。
PrivateKey string 示例值：-----BEGIN RSA PRIVATE KEY-----\nMIIEogIB......vhUorDg=\n-----END RSA PRIVATE KEY-----\n``
私钥。
SerialNumber string 示例值：00000000089E14D489AC80161569F34A29D6CEA7
序列号。
KeyAlgorithm string 示例值：RSA 2048
密钥算法。
SignatureAlgorithm string 示例值：SHA256-RSA
签名算法。
FingerPrintSha256 string 示例值：A53B846E14B33939E6CD7F9CF320FD9F96AB1D466A224CD28A38DC1388F51248
SHA-256指纹。
FingerPrintSha1 string 示例值：AAB216FF78244113D199CB87A8FE62992DB56EF0
SHA-1指纹。
ProjectName string 示例值：default
证书实例所属火山引擎项目的名称。
Tags object[] 示例值：
证书实例绑定的资源标签列表。
Key string 示例值：env
标签键。
Value string 示例值：test
标签值。
CreatedTime string 示例值：2024-12-26 19:15:11
证书实例的创建时间。
请求示例
POST /?Action=CertificateGetInstance&Version=2024-10-01 HTTP/1.1
Host: certificate-service.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260511T024040Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260511/cn-beijing/certificate_service/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{
"InstanceId": "cert-c88df6d4a1b348c3b714b746d3cc****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20260511104057095113132112650168",
"Action": "CertificateGetInstance",
"Version": "2024-10-01",
"Service": "certificate_service",
"Region": "cn-beijing"
},
"Result": {
"ValidationType": "dns_txt",
"MultiDomainInstanceConf": {
"StandardDomainNumber": 0,
"WildcardDomainNumber": 0
},
"InstanceId": "cert-c88df6d4a1b348c3b714b746d3cc****",
"AccountId": "210000XXXX",
"SourceId": "cert-6d580ffd930e42239dad01b56654****",
"Tag": "未命名证书",
"Status": "Issued",
"InstanceType": "Paid",
"InstanceLevel": "dv",
"OrderBrand": "digicert",
"OrderOrganizationId": "org-685e6a2bae5b46bcacbe3a82965e****",
"OrderPeriod": 12,
"OrderPlan": "digicert_wildcard_dv",
"CertificateDomainType": "Wildcard",
"IsCertificateSm": true,
"IsCertificateRevoked": true,
"CommonName": "*.example.com",
"San": [
"*.example.com"
],
"NotBefore": "2024-12-26 08:00:00",
"NotAfter": "2025-01-25 07:59:59",
"CertificateDetail": {
"Subject": {
"CommonName": "*.example.com",
"Organization": "测试企业",
"OrganizationUnit": "系统部",
"Country": "CN",
"Province": "Shanghai",
"Locality": "Shanghai",
"Address": "某某街道某号",
"PostalCode": "310000"
},
"Issuer": {
"CommonName": "*.example.com",
"Organization": "测试企业",
"OrganizationUnit": "系统部",
"Country": "CN",
"Province": "Shanghai",
"Locality": "Shanghai",
"Address": "某某街道某号",
"PostalCode": "310000"
},
"Chain": [
"`[\n \"-----BEGIN CERTIFICATE-----\\nMIIEqzCC......mSD5gds=\\n-----END CERTIFICATE-----\\n\",\n \"-----BEGIN CERTIFICATE-----\\nMIIEszCC......../m8Fxw==\\n-----END CERTIFICATE-----\\n\",\n \"-----BEGIN CERTIFICATE-----\\nMIIDjjCC......fl\\nMrY=\\n-----END CERTIFICATE-----\\n\"\n ]`"
],
"PrivateKey": "`-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIB......vhUorDg=\\n-----END RSA PRIVATE KEY-----\\n`",
"SerialNumber": "00000000089E14D489AC80161569F34A29D6CEA7",
"KeyAlgorithm": "RSA 2048",
"SignatureAlgorithm": "SHA256-RSA",
"FingerPrintSha256": "A53B846E14B33939E6CD7F9CF320FD9F96AB1D466A224CD28A38DC1388F51248",
"FingerPrintSha1": "AAB216FF78244113D199CB87A8FE62992DB56EF0"
},
"EncryptionCertificateDetail": {
"Subject": {
"CommonName": "*.example.com",
"Organization": "测试企业",
"OrganizationUnit": "系统部",
"Country": "CN",
"Province": "Shanghai",
"Locality": "Shanghai",
"Address": "某某街道某号",
"PostalCode": "310000"
},
"Issuer": {
"CommonName": "*.example.com",
"Organization": "测试企业",
"OrganizationUnit": "系统部",
"Country": "CN",
"Province": "Shanghai",
"Locality": "Shanghai",
"Address": "某某街道某号",
"PostalCode": "310000"
},
"Chain": [
"`[\n \"-----BEGIN CERTIFICATE-----\\nMIIEqzCC......mSD5gds=\\n-----END CERTIFICATE-----\\n\",\n \"-----BEGIN CERTIFICATE-----\\nMIIEszCC......../m8Fxw==\\n-----END CERTIFICATE-----\\n\",\n \"-----BEGIN CERTIFICATE-----\\nMIIDjjCC......fl\\nMrY=\\n-----END CERTIFICATE-----\\n\"\n ]`"
],
"PrivateKey": "`-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIB......vhUorDg=\\n-----END RSA PRIVATE KEY-----\\n`",
"SerialNumber": "00000000089E14D489AC80161569F34A29D6CEA7",
"KeyAlgorithm": "RSA 2048",
"SignatureAlgorithm": "SHA256-RSA",
"FingerPrintSha256": "A53B846E14B33939E6CD7F9CF320FD9F96AB1D466A224CD28A38DC1388F51248",
"FingerPrintSha1": "AAB216FF78244113D199CB87A8FE62992DB56EF0"
},
"ProjectName": "default",
"Tags": [
{
"Key": "env",
"Value": "test"
}
],
"CreatedTime": "2024-12-26 19:15:11"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | NotFound.CertificateInstance | The specified certificate was not found. | 未找到指定的证书。 |
500 | InternalError | The request has failed due to an unknown error. | 未知错误。 |
最近更新时间：2026.05.11 11:17:46
这个页面对您有帮助吗？
有用
有用
无用
无用