按 ID 获取报告

GET
https://api.digicert.com/reports/v1/report/{{report_identifier}}

使用此端点通过提供报告 ID 返回报告相关信息。

必须在帐户中启用报告库功能,该端点才能成功响应。

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/reports/preview/report/{{report_identifier}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

url = "https://www.digicert.com/services/v1/reports/preview/report/{{report-identifier}}"

payload={}
headers = {
  'Content-Type': 'application/json',
  'X-DC-DEVKEY': '{{api_key}}',
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Go
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://www.digicert.com/services/v1/reports/preview/report/{{report-identifier}}"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-DC-DEVKEY", "{{api_key}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
NodeJS
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v1/reports/preview/report/{{report-identifier}}',
  'headers': {
    'Content-Type': 'application/json',
    'X-DC-DEVKEY': '{{api_key}}',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
200 OK
{
    "report": {
        "report_display_name": "RPT01",
        "report_identifier": "b80de6e4-f085-4488-a47f-b7b5ea07e05e",
        "created_by_user_id": 10192361,
        "created_by_user_name": "venkat patil",
        "created_date": "2021-01-13 09:43:17",
        "report_metadata": {
            "columns": [
                {
                    "identifier": "account_id"
                },
                {
                    "identifier": "number_of_sans"
                },
                {
                    "identifier": "certificate_id"
                },
                {
                    "identifier": "certificate_validity_days"
                },
                {
                    "identifier": "container_id"
                },
                {
                    "identifier": "container_name"
                }
            ],
            "report_type": "orders"
        },
        "schedule": {
            "frequency": "WEEKLY", //Possible values ON_DEMAND,WEEKLY,MONTHLY
            "weekday_to_run": "WEDNESDAY", // Possible values SUNDAY to SATURDAY, ""
            "weekday_frequency": "", // Possible values FIRST, SECOND, THIRD, FOURTH, LAST, ""
            "run_until": "2021-12-23"
        },
        "next_run_date": "2021-01-20",
         "format": [
            "CSV" // Possible value only CSV
        ],
        "status": "ACTIVE"  // Always ACTIVE
    }
}
401 Invalid user
{
"code": "user_authentication_error",
"message": "User is not authenticated."
}
403 Forbidden
{
    "code": "user_forbidden",
    "message": "User does not have the required permission."
}
403 Not enabled
{
    "code": "custom_reports_not_enabled",
    "message": "Custom reports is not enabled"
}
404 Report not found
{
    "code": "reports_not_found",
    "message": "Report with the given identifier does not exist."
}
404 Page not found
404 page not found

路径参数

名称 请求/选项 类型 描述
report-identifier 必填 string 创建报告 API 响应中显示的报告 ID。

响应参数

名称 类型 描述
report object 容器。
report_display_name string 为报告指定的名称。
.. report_identifier string 创建报告 API响应中显示的报告 ID。
.. created_by_user_id string 与报告创建者相关的用户 ID。
.. created_date string 报告的创建日期,包括时间戳,格式:年-月-日 小时-分钟-秒钟。
.. created_by_user_name string 与创建报告相关的用户名。
.. report_metadata object 容器。
.. .. columns object 报告中指定的列的类型。
.. .. .. identifier string 报告库 API 支持的列标识符。有关所有支持的列的列表,请参阅报告库 API 列
.. .. report_type string 报告的类型。
.. schedule object 容器。
.. .. frequency string 创建报告的频率。可能的值:ON_DEMAND, WEEKLY, MONTHLY. 值区分大小写。
.. .. weekday_to_run string 每周创建报告的日期。可能的值:SUNDAYSATURDAY。值区分大小写。
.. .. weekday_frequency string 每个工作日创建报告的次数。可能的值: FIRST, SECOND, THIRD, FOURTH, LAST. 值区分大小写。
.. .. run_until date 停止创建该报告的日期。格式:年-月-日。
.. next_run_date date 恢复创建该报告的日期。格式:年-月-日。
.. format string 报告的格式。对于此端点,可能的值是CSV。如需返回 JSON 格式的报告,请参阅获取 JSON 报告 API
.. status string 报告的状态。所有预约的报告都是ACTIVE