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"
            }
        ]
    }
}

引數

納入要篩選、搜尋或控制資料的查詢引數。使用逗號分隔多個引數。除了 sort 外,,所有引數都使用 key:value 格式 (例如 status:"issued")。

篩選器

使用篩選器引數縮小指定參數值的查詢資料範圍。可使用多個篩選器進一步縮小結果範圍。

名稱 必填/選填 類型 說明
id 選填 int 訂單 ID。
status 選填 string 訂單狀態。
請參閱詞彙 — 訂單狀態
valid_from 選填 string 憑證有效期限開始日期。
格式:yyyy-MM-dd
運算子:>=
valid_till 選填 string 憑證有效期限結束日期。
格式:yyyy-MM-dd
運算子:<=
container_id 選填 string 容器 ID。
organization_id 選填 string 組織 ID。
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

排序和分頁

使用排序和分頁引數控制傳回的查詢結果。

名稱 必填/選填 類型 說明
sort 選填 array 指定排序欄位和方向。
格式:["{{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 憑證 ID。
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 (偽),1 (真)
disable_renewal_notifications string 說明是否啟用續訂通知。
可能的值:0 (偽),1 (真)
dns_names string 由憑證保護安全的其他名稱的逗號分隔的清單。
email string 如果憑證有內嵌的電郵地址 (例如用戶端憑證),則會傳回憑證上的電郵地址。
firstname string 組織聯絡人的名字。
has_duplicates int 說明憑證是否有複本。
可能的值:0 (偽),1 (真)
id string 訂單 ID。
is_out_of_contract string 訂單的合約狀態。
可能的值:0 (偽),1 (真)
is_renewed string 說明訂單是否已續訂。
可能的值:0 (偽),1 (真)
issuer_common_name string 發行憑證授權機關的易記名稱。
job_title string 組織聯絡人的職稱。
lastname string 組織聯絡人的姓氏。
locale string 訂單的地區設定。
請參閱詞彙 — 地區設定代碼
中繼資料 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 說明是否啟用訂單的額外功能。
可能的值: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 收據 ID。
Renewed string 說明訂單是否已續訂。
可能的值:FALSE,TRUE
renewed_order_id string 之前訂單的訂單 ID。
僅在訂單續訂時傳回。
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 包含查詢的欄位的訂單物件的清單。
.. .. {{欄位}} - 查詢的欄位和值。
傳回的欄位視傳出的查詢而定。