order_details

QUERY
https://www.digicert.com/services/v2/reports/query

使用此查询获取关于所有证书订单的特定详细信息。

要获取单个证书订单的特定详细信息,请使用 order_details_by_id 查询

GraphQL
{
    order_details(valid_till:"2020-10-26",limit:5,sort:["valid_from","DESC"]) {
        id
        common_name
        dns_names
        organization_id
        status
        valid_from
        valid_till
    }
}
200 OK
{
    "data": {
        "order_details": [
            {
                "id": "123456",
                "common_name": "digicert.com",
                "dns_names": null,
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-10-04",
                "valid_till": "2020-10-08"
            },
            {
                "id": "123458",
                "common_name": "dev.digicert.com",
                "dns_names": null,
                "organization_id": "223344",
                "status": "issued",
                "valid_from": "2019-10-03",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123443",
                "common_name": "example.com",
                "dns_names": "sub.example.com,www.example.com",
                "organization_id": "112233",
                "status": "revoked",
                "valid_from": "2019-10-02",
                "valid_till": "2020-10-06"
            },
            {
                "id": "123460",
                "common_name": "example.net",
                "dns_names": "www.example.net",
                "organization_id": "112233",
                "status": "issued",
                "valid_from": "2019-09-30",
                "valid_till": "2020-10-07"
            },
            {
                "id": "123424",
                "common_name": "example.org",
                "dns_names": "test.example.org,monitor.example.org,api.example.org",
                "organization_id": "334455",
                "status": "issued",
                "valid_from": "2019-09-27",
                "valid_till": "2020-10-01"
            }
        ]
    }
}

参数

包括要筛选、搜索或操作数据的查询参数。使用逗号分隔多个参数。排序例外,所有参数使用 key:value 格式(例如,status:"issued")。

筛选项

使用筛选项参数将查询数据缩小至指定的参数值。可以使用多个筛选项进一步缩小结果范围。

名称 请求/选项 类型 描述
id 可选 int 订单编号。
status 可选 string 订单状态。
请参阅词汇表 - 订单状态
valid_from 可选 string 证书有效期开始日期。
格式:yyyy-MM-dd
运算符:>=
valid_till 可选 string 证书有效期结束日期。
格式:yyyy-MM-dd
运算符:<=
container_id 可选 string 容器 ID。
organization_id 可选 string 组织编号。
product_name_id 可选 string 产品的名称 ID。
请参阅词汇表 - 产品标识符
serial_number 可选 string 证书序列号。
signature_hash 可选 string 用于给证书请求签名的签名哈希。
user_id 可选 string 下达订单的用户的 ID。
date_created 可选 string 下达订单的日期。
格式:yyyy-MM-dd HH:mm:ss
运算符:>=
ca_cert_id 可选 string 证书颁发机构的 ID。
common_name 可选 string 证书保护的名称。
使用 % 用于 like 运算符(例如,common_name:"%example.com")。
dns_names 可选 string 证书保护的其他名称的列表。
locale 可选 string 订单的区域。
请参阅词汇表 - 区域代码
thumbprint 可选 string 证书拇指指纹。
email 可选 string 自定义订单电子邮件。

搜索

使用搜索参数查找在搜索字段中包含的特定字符串。

名称 请求/选项 类型 描述
search 可选 string 在特定字段中搜索所含字符串。
使用 % 用于 like 运算符(例如,search:"%example.com")。
搜索的字段:id, status, container_id, organization_id, product_name_id, additional_emails, organization_name, product_name, serial_number, user_id, common_name, email

排序和编页

使用排序和编页参数操作返回的查询结果。

名称 请求/选项 类型 描述
排序 可选 数组 指定排序字段和方向。
格式:["{{field}}","{{direction}}"]
允许的值(字段):valid_till,container_id,organization_id,product_name_id,serial_number,signature_hash,user_id,date_created,ca_cert_id,common_name,dns_names,locale,thumbprint,email
允许的值(方向):ASC,DESC
默认值:["id","DESC"]
offset 可选 int 在特定分页页码开始列表。
默认值:0
limit 可选 int 将列表截断到指定的分页页码。
最大值:1000(默认)

字段

请求中必须包含至少一个字段。如果没有发送任何字段,则返回句法错误。

如果字段不存在数据,则返回 null 值。

名称 类型 描述
account_id string 与订单关联的帐户 ID。
additional_emails string 订单上的其他电子邮件地址。
agreement_id string CSA 同意的 ID。
auto_renew string 指定证书是否应自动续订。
可能的值:0(禁用),1(启用)
ca_cert_id string 证书颁发机构的 ID。
certificate_tracker_id string 证书编号。
common_name string 证书保护的名称。
contacts_email string 组织联系人电子邮件地址。
container_id string 订单的容器 ID。
container_name string 订单的容器名称。
cost string 订单费用。
csr string 证书签名请求 (CSR)。
custom_renewal_message string 包括在续订通知中的自定义消息。
customer_order_id string 自定义订单 ID。
date_created string 下达订单的日期。
格式:yyyy-MM-dd HH:mm:ss
dcv_method string 为域配置的域控制验证。
请参阅词汇表 - DCV 方法
disable_issuance_email string 指定是否发送颁发电子邮件。
可能的值:0 (false),1 (true)
disable_renewal_notifications string 指定是否启用续订通知。
可能的值:0 (false),1 (true)
dns_names string 证书保护的附加名称的列表(用逗号分隔)。
email string 如果证书嵌入了电子邮件地址(例如,客户端证书),则返回证书上的电子邮件地址。
firstname string 组织联系人的名字。
has_duplicates int 指定证书是否有副本。
可能的值:0 (false),1 (true)
id string 订单编号。
is_out_of_contract string 订单的合同状态。
可能的值:0 (false),1 (true)
is_renewed string 指定订单是否已续订。
可能的值:0 (false),1 (true)
issuer_common_name string 证书颁发机构的友好名称。
job_title string 组织联系人的职位名称。
lastname string 组织联系人的姓氏。
locale string 订单的区域。
请参阅词汇表 - 区域代码
元数据 字符串 自定义字段详细信息。
格式:{{metadata_id}}{{metadata_label}}{{metadata_value}}数据分隔符:0x1f
org_addr1 string 组织地址。
org_addr2 string
organization_city string 组织所在的城市。
organization_country string 组织所在的国家/地区。
organization_id string 与订单关联的组织 ID。
organization_name string 组织名称。
organization_state string 组织所在的州。
organization_unit string 证书上的组织单位。
pay_type string 订单使用的付款方式。
可能的值:A(帐户余额),C(信用卡)
plus_feature string 指定是否对订单启用 Plus 功能。
可能的值:0(禁用),1(启用)
product_id string 产品的 ID。
product_name string 显示产品名称。
请参阅词汇表 - 产品标识符
product_name_id string 产品的名称 ID。
请参阅词汇表 - 产品标识符
product_type string 产品类型。
请参阅词汇表 - 产品类型
purchased_dns_names string 购买的额外 SAN 的数量。
receipt_id string 接收人编号。
Renewed string 指定订单是否已续订。
可能的值:FALSE,TRUE
renewed_order_id string 上一个订单的订单编号。
仅当订单为续订订单时返回。
serial_number string 证书序列号。
serversw string 服务器平台 ID。
请参阅词汇表 - 服务器平台
signature_hash string 用于给证书请求签名的签名哈希。
status string 订单状态。
请参阅词汇表 - 订单状态
telephone string 组织联系人的电话号码。
thumbprint string 证书拇指指纹。
user_assignments string 分配给订单的用户的 ID。
user_email string 请求证书的用户的电子邮件地址。
user_first_name string 请求证书的用户的名字。
user_id string 下达订单的用户的 ID。
user_last_name string 请求证书的用户的姓氏。
valid_from string 证书有效期开始日期。
格式:yyyy-MM-dd
valid_till string 证书有效期结束日期。
格式:yyyy-MM-dd
validity_years string 证书的有效年限。

响应参数

名称 类型 描述
data object 返回的查询数据的容器。
.. order_details array 含有所查询字段的订单对象的列表。
.. .. {{字段}} - 查询的字段和值。
依赖于所发送查询的返回字段。