查询证书详情

最近更新时间：2023.09.22 16:31:33

首次发布时间：2022.03.16 16:36:23

API 说明

API 名称：CertificateGetInstance。
API 域名：open.volcengineapi.com。
API 描述：查询您的SSL证书的详情。

请求方法

GET

使用限制

QPS 限制：同一个租户每秒最多允许请求 20 次。

公共请求头参数

在调用该 API 时，您在请求中必须包含公共参数。在这些公共参数中，以下三个请求头（header）参数的取值说明如下：

参数名称	数据类型	是否必选	参数说明	示例
Region	String	是	服务的地区。该参数的取值是 cn-north-1。	`cn-north-1`
ServiceName	String	是	服务的名称。该参数的取值是 certificate_service。	`certificate_service`
X-Upstream	String	是	上游服务的地址。该参数的取值是 volcano。	`volcano`

请求参数

参数名称	数据类型	是否必选	参数说明	示例
Action	String	是	API 的名称。该参数的取值是 CertificateGetInstance。	`CertificateGetInstance`
Version	String	是	API 的版本。该参数的取值是 2021-06-01。	`2021-06-01`
limit	Integer	否	设置要返回的证书的最大数量。最大值：100。默认返回所有的证书且最多能够返回 100 个证书。	`1`
offset	Integer	否	设置要返回证书的起始位置。默认值：0。该参数必须与 limit 同时使用。 page 与 offset 二选一。如果您同时设置了 page 和 offset，则 page 优先生效。	`1`
page	Integer	否	设置要返回的证书所在的页码。默认值：1。该参数必须与 limit 同时使用。 page 与 offset 二选一。如果您同时设置了 page 和 offset，则 page 优先生效。	`1`
instance_id	String	否	设置该参数以按证书实例 ID 查询证书。您可以设置一个或多个证书实例的 ID。多个 ID 间使用半角逗号（,）分隔。	`cert-310a6640e2ef4c1dbe5065c62821****`
chain_id	String	否	设置该参数以按证书关系链 ID 查询证书。您可以设置一个或多个证书关关系链的 ID。多个 ID 间使用半角逗号（,）分隔。证书关系链反映了证书的续费历史。假设证书 A 到期时，您为证书续费并获得了证书 B，那么证书 A 和 B 处于同一条证书关系链。	`cert-4c803831980c4681b22d9432527b****`
tag	String	否	设置该参数以按证书标签查询证书。您可以设置一个标签。支持模糊匹配。	`未命名证书`
purpose	String	否	设置该参数以按证书用途查询证书。该参数的取值是 ssl。	`ssl`
instance_type	Integer	否	设置该参数以按证书类型查询证书。该参数有以下取值： 0：付费证书 1：免费证书 2：上传的证书	`1`
type	String	否	设置该参数以按证书类型查询证书。该参数有以下取值： dv：域名验证 ov：组织验证 ev：扩展验证	`dv`
common_name	String	否	设置该参数以按证书公用名（CN）查询证书。您可以设置一个公用名。支持模糊匹配。	`www.example.com`
domain	String	否	设置该参数以按证书能够保护的域名查询证书。您可以设置一个域名。	`www.example.com`
order_exist	Boolean	否	是否只返回通过证书中心购买的证书。该参数有以下取值： true：是 false：否	`true`
order_brand	String	否	设置该参数以按证书品牌查询证书。该参数有以下取值： digicert_free：免费证书 digicert：DigiCert geotrust：GeoTrust digicert_pro：DigiCert Pro globalsign：GlobalSign alpha：Alpha vTrus：vTrus 国际标准证书 tianwei_sm：vTrus 国密标准证书 wotrus：WoTrus 国际标准证书 wotrus_sm：WoTrus 国密标准证书	`digicert_free`
order_san_number	Integer	否	设置该参数以按域名类型查询证书。该参数有以下取值： -1：只返回通配符域名证书 0：只返回单域名证书其他具体数值（如 5）：只返回包含特定数量（如 5 个）域名的多域名证书	`0`
order_status	String	否	设置该参数以按证书状态查询证书。该参数有以下取值： -2：未知状态 100：尚未提交证书申请 101：证书申请尚未提交给 CA 机构 200：验证中 201：取消中 202：取消失败 300：已签发 301：已取消 302：申请失败 400：吊销中 401：吊销失败 500：已吊销	`300`
certificate_exist	Boolean	否	是否只返回已签发的证书。该参数有以下取值： true：是 false：否	`true`
certificate_expire_before	String	否	使用该参数与 certificate_expire_after 参数共同指定一个时间段，使接口只返回到期时间在指定时间段内的证书。 certificate_expire_after 参数用于指定时间段的起点，该参数用于指定时间段的终点。时间的格式为：yyyy-mm-dd hh:mm:ss。	`2023-12-31 00:00:00`
certificate_expire_after	String	否	使用该参数与 certificate_expire_before 参数共同指定一个时间段，使接口只返回到期时间在指定时间段内的证书。该参数用于指定时间段的起点，certificate_expire_before 参数用于指定时间段的终点。时间的格式为：yyyy-mm-dd hh:mm:ss。	`2023-01-01 00:00:00`
certificate_valid	Boolean	否	是否只返回合法的证书。合法的证书表示证书已签发，在有效期内，并且没有被吊销。该参数有以下取值： true：是 false：否	`true`
certificate_revoked	Boolean	否	是否只返回被吊销的证书。该参数有以下取值： true：是 false：否	`false`
project_name	String	否	设置该参数以按证书所属项目查询证书。	`default`

响应正文

参数名称	数据类型	参数说明	示例
count	Integer	满足查询条件的证书的数量。	`1`
content	JSON Array	证书的详情。

示例

请求示例

GET https://open.volcengineapi.com/?Action=CertificateGetInstance&Version=2021-06-01&<其他公共请求参数>

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20230118181712F40954516F4ACD0335B7",
        "Action": "CertificateGetInstance",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": {
        "count": 1,
        "content": [
            {
                "id": "cert-088ad60bb6834778bc99cf559957****",
                "parent_id": "cert-088ad60bb6834778bc99cf559957****",
                "chain_id": "cert-4c803831980c4681b22d9432527b****",
                "upstream": "volcano",
                "upstream_filter": "2100171166",
                "deleted": 0,
                "source_parent_id": "",
                "source_id": "",
                "number": 1,
                "cert_type": 1,
                "instance_type": 1,
                "disabled": 0,
                "tag": "未命名证书",
                "purpose": "ssl",
                "type": "dv",
                "common_name": "www.example.com",
                "applicable_domains": ",www.example.com,",
                "order_exist": 1,
                "order_brand": "digicert_free",
                "order_san_number": 0,
                "order_status": 300,
                "order_require_progress": 0,
                "certificate_exist": 1,
                "certificate_revoked": 0,
                "deploy_info": null,
                "project_name": "default",
                "issuer": "Encryption Everywhere DV TLS CA - G1",
                "is_sm": false,
                "order_period": 12,
                "order_organization": {
                    "department": "",
                    "name": "",
                    "postal_code": "",
                    "address": "",
                    "city": "",
                    "province": "",
                    "country": "",
                    "email": "",
                    "phone": "",
                    "bank_account_license_no": "",
                    "business_license_no": "",
                    "contact": {
                        "first_name": "三",
                        "last_name": "张",
                        "email": "zhangsan@example.com",
                        "phone": "13011111111",
                        "title": "",
                        "id_card_no": ""
                    },
                    "upstream_extension": null
                },
                "ssl": {
                    "order_san_number": 0,
                    "order_validation_type": "dns_txt",
                    "order_validation_ready": true,
                    "order_validations": {
                        "www.example.com": {
                            "key": [
                                "_dnsauth.www.example.com"
                            ],
                            "value": "2022120700000010dx4i3xvck9vxw67rdltp55hju8gtumx629eelkupk24hmisc",
                            "validated": false
                        }
                    },
                    "san": [
                        "www.example.com"
                    ],
                    "certificate": {
                        "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC......sg==\n-----END CERTIFICATE REQUEST-----\n",
                        "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIE......Ow==\n-----END RSA PRIVATE KEY-----\n",
                        "key_type": "rsa",
                        "chain": [
                            "-----BEGIN CERTIFICATE-----\nMIIF......1Wk=\n-----END CERTIFICATE-----\n",
                            "-----BEGIN CERTIFICATE-----\nMIIE......lg==\n-----END CERTIFICATE-----\n",
                            "-----BEGIN CERTIFICATE-----\nMIID......bd4=\n-----END CERTIFICATE-----\n"
                        ],
                        "encrypt_key": "",
                        "encrypt_chain": null
                    }
                },
                "log": [
                    {
                        "time": "2022-12-08 09:30:47",
                        "title": "待申请",
                        "content": "订单已创建，等待提交证书申请。"
                    }
                ],
                "upstream_extension": {
                    "plan": "digicert_free_standard_dv",
                    "sub_order_id": "Suborder717458362305575****",
                    "income_confirmed": true,
                    "dns": [
                        {
                            "RecordID": "30012274",
                            "ZoneName": "example.com",
                            "Line": "default",
                            "Host": "_dnsauth.www",
                            "Type": "TXT",
                            "Value": "2022120700000010dx4i3xvck9vxw67rdltp55hju8gtumx629eelkupk24hmisc"
                        }
                    ],
                    "is_completed": true
                },
                "order_progress_time": "2022-12-08 09:41:55",
                "certificate_not_before": "2022-12-08 08:00:00",
                "certificate_not_after": "2023-12-09 07:59:59",
                "certificate_not_after_ms": 1702079999000,
                "certificate_not_before_ms": 1670457600000,
                "certificate_detail": {
                    "subject": {
                        "common_name": "www.example.com",
                        "san": [
                            "www.example.com"
                        ],
                        "organization": "",
                        "organization_unit": "",
                        "country": "",
                        "province": "",
                        "city": "",
                        "address": "",
                        "postal_code": ""
                    },
                    "issuer": {
                        "common_name": "Encryption Everywhere DV TLS CA - G1",
                        "san": null,
                        "organization": "DigiCert Inc",
                        "organization_unit": "www.digicert.com",
                        "country": "US",
                        "province": "",
                        "city": "",
                        "address": "",
                        "postal_code": ""
                    },
                    "serial_number": "000000000AC959EE6AD3ACE2B227560537A23E4A",
                    "not_before": "2022-12-08 08:00:00",
                    "not_after": "2023-12-09 07:59:59",
                    "encryption_algorithm": "RSA 2048",
                    "signature_algorithm": "SHA256-RSA",
                    "fingerprint_sha_1": "95C06EA2E180DA44753A44BAD5C9B780F67ACBAD",
                    "fingerprint_sha_256": "AC274E535A5B0C11D29A1BC154512967E3DDD92DC06B9C2ACDE68ED681BA1915"
                },
                "encryption_certificate_detail": null
            }
        ]
    }
}

错误代码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。关于更多错误码的信息，参见错误码说明。

API 说明

请求方法

使用限制

公共请求头参数

请求参数

响应正文

示例

请求示例

响应示例

错误代码

证书中心

查询证书详情

API 说明

请求方法

使用限制

公共请求头参数

请求参数

响应正文

示例

请求示例

响应示例

错误代码