调用本接口查询您的SSL证书的详情。
暂不支持。
下方表格中的参数包含在请求头（header）中。
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| Region | string | 是 | 服务地区。该参数的取值是cn-north-1。 | cn-north-1 |
| ServiceName | string | 是 | 服务名称。该参数的取值是certificate_service。 | certificate_service |
下方表格中的参数包含在查询字符串（query string）中。
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| Action | string | 是 | API名称。该参数的取值是CertificateGetInstance。 | CertificateGetInstance |
| Version | string | 是 | API版本。该参数的取值是2021-06-01。 | 2021-06-01 |
| limit | Integer | 否 | 设置每页的证书数量。 默认值：100。最大值：100。 | 1 |
offset | Integer | 否 | 设置开始返回证书之前要跳过的证书数量。默认值： |
|
page | Integer | 否 | 设置要返回的证书所在的页码。默认值： |
|
instance_id | String | 否 | 设置该参数以按证书实例ID查询证书。您可以设置一个或多个ID。多个ID间使用半角逗号（,）分隔。 |
|
chain_id | String | 否 | 设置该参数以按证书关系链ID查询证书。您可以设置一个或多个ID。多个ID间使用半角逗号（,）分隔。 |
|
source_id | String | 否 | 设置该参数以按被续费证书实例的ID查询证书。您可以设置一个或多个ID。多个ID间使用半角逗号（,）分隔。 |
|
tag | String | 否 | 设置该参数以按证书标签查询证书。只能设置一个标签。支持模糊匹配。 |
|
purpose | String | 否 | 设置该参数以按证书用途查询证书。该参数的取值是 |
|
instance_type | Integer | 否 | 设置该参数以按证书类型查询证书。该参数有以下取值：
|
|
type | String | 否 | 设置该参数以按证书类型查询证书。该参数有以下取值：
|
|
common_name | String | 否 | 设置该参数以按证书公用名（CN）查询证书。只能设置一个公用名。支持模糊匹配。 |
|
domain | String | 否 | 设置该参数以按证书能够保护的域名查询证书。只能设置一个域名。 |
|
order_exist | Boolean | 否 | 是否只返回从证书中心购买的证书。该参数有以下取值：
|
|
order_brand | String | 否 | 设置该参数以按证书品牌查询证书。该参数有以下取值：
| digicert_free |
| Integer | 否 | 设置该参数以按域名类型查询证书。该参数有以下取值：
|
|
| Integer | 否 | 设置该参数以按证书状态查询证书。该参数有以下取值：
|
|
| Boolean | 否 | 是否只返回已签发的证书。该参数有以下取值：
|
|
| String | 否 | 使用该参数与 |
|
| String | 否 | 使用该参数与 |
|
| Boolean | 否 | 是否只返回合法的证书。合法的证书表示证书已签发，在有效期内，并且没有被吊销。该参数有以下取值：
|
|
| Boolean | 否 | 是否只返回被吊销的证书。该参数有以下取值：
|
|
| String | 否 | 设置该参数以按证书所属项目查询证书。 |
|
参数 | 类型 | 描述 | 示例值 |
|---|---|---|---|
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请求失败。您可访问公共错误码，获取更多错误码信息。