文档中心

Appearance

查询产品候选证书链 ​

GET
/openapi/v3/products/:id/certificate-chains

在创建、重颁发或续期前，查询指定产品和密钥算法下可用的签发 ICA 与交付路径。需要 API Key 的订单访问权限。账户身份由鉴权确定，无需传入账户 ID。

请求参数 ​

路径参数 ​

参数类型必填说明
idstring是产品 ID，参见产品列表

查询参数 ​

参数类型必填说明
key_algostring是密钥算法，区分大小写：RSA、ECDSA、SM2。应与将提交的 CSR 或密钥算法一致
order_idstring否查询原订单当前 ICA 下的交付路径时传入；订单必须属于当前账户、匹配产品且可被当前调用者访问。返回范围固定为订单当前签发配置；需要查看可切换的 ICA 时不传此参数
chain_idinteger否按签发 ICA 配置 ID 筛选，取值为 1～2147483647

以上参数显式传空、重复传入，或 chain_id 不是有效的正整数，会返回 HTTP 400。本接口一次返回全部可选 ICA 和路径，无需分页。

返回数据 ​

字段类型说明
product_idstring产品 ID
default_chain_idinteger当前密钥算法的默认 ICA 配置 ID；没有匹配项时为 0。该 ID 可能不在过滤后的 chains 中，不代表一定可选
chainsarray[object]当前可选且 ICA 证书处于有效期内的条目；无匹配项时为 []，例如产品不支持该算法或筛选无结果
∟ chain_idinteger创建、重颁发或订阅期内续期的 certificate.chain_id 候选值；提交时仍需满足相应接口的限制
∟ issuer_materialobject / nullICA 身份信息，见 MaterialIdentity
∟ optionsarray[object]该 ICA 下全部当前可选的登记路径，见 Candidate；为 [] 时没有可新选择的登记路径，但仍可能使用旧式默认链

创建、重颁发或续期时，chain_id 与 cross_chain 必须来自同一个 ICA 项，不能从不同的 chains 项中混用。带 order_id 的查询只列出订单当前 ICA；如需切换 ICA，请省略 order_id 查询产品候选。产品候选可能覆盖多个 CA 账户，重颁发和续期仍只允许当前订单 CA 账户下的 ICA，且受签发服务支持范围限制。

请求示例 ​

替换示例产品 ID 和鉴权值后调用；只查询原订单当前 ICA 下的路径时，增加 order_id。

bash
curl --get 'https://api.certcloud.cn/openapi/v3/products/digicert_ssl_ov/certificate-chains' \
  -H 'X-CC-Auth-Key: your-auth-key' \
  -H 'X-CC-Key-ID: your-key-id' \
  --data-urlencode 'key_algo=RSA'

响应示例 ​

以下编号、名称和指纹仅为示例；实际选择请使用本账户接口返回的值。

200成功
json
{
  "code": "success",
  "data": {
    "product_id": "digicert_ssl_ov",
    "default_chain_id": 7,
    "chains": [
      {
        "chain_id": 7,
        "issuer_material": {
          "sha1": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
          "common_name": "Example Issuing CA",
          "subject_ou": "",
          "not_before": "2025-01-01T00:00:00Z",
          "not_after": "2035-01-01T00:00:00Z"
        },
        "options": [
          {
            "cross_chain": 1002,
            "display_name": "示例原生交付链",
            "chain_materials": [
              {
                "sha1": "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
                "common_name": "Example Root CA",
                "subject_ou": "",
                "not_before": "2025-01-01T00:00:00Z",
                "not_after": "2035-01-01T00:00:00Z"
              }
            ]
          }
        ]
      }
    ]
  }
}

处理说明 ​

接口已过滤不可选的 ICA 和路径。查询结果不预留可用性，提交订单时会重新校验；如果返回的编号随后不可用，应刷新候选列表。错误与重试规则见证书链错误码。