GetReportTemplate - 擷取合規報告模版詳情 - Cloud Config

擷取合規報告模版詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
ReportTemplateId	string	是	報告模版 Id	crt-xxx

返回參數

名稱	類型	描述	樣本值
	object
ReportTemplate	object	報告模版
ReportTemplateId	string	報告模版 Id	crt-xxx
ReportTemplateName	string	報告模版名稱	test-name
SubscriptionFrequency	string	報告訂閱頻率。如果此欄位非空，則為訂閱通知觸發的 Quartz 格式的 Cron 運算式。格式為：秒分時日月周。以下是常用的 Cron 運算式樣本：每天 0 點執行：0 0 0 * * ? 每周一 15 點 30 執行：0 30 15 ? * MON 每月 1 號 2 點執行：0 0 2 1 * ? 其中： "*"表示任意值 ? 用於日和周欄位，表示不指定具體值 MON 表示星期一說明觸發時間為 UTC+8，可自行根據時區轉換 cron 運算式的設定。說明只能保證盡量按照 cron 運算式時間進行觸發，可能由於報告生產狀態有所延遲。cron 運算式會限制同一模版每天最多觸發一次通知。說明除了用 MON 表示星期一以外，也可以用數字。不過需要注意，在 Quartz 架構中： 1 代表星期日（Sunday）；2 代表星期一（Monday）；3 代表星期二（Tuesday）；4 代表星期三（Wednesday）；5 代表星期四（Thursday）；6 代表星期五（Friday）；7 代表星期六（Saturday）	0 0 0 * * ?
ReportTemplateDescription	string	報告模版描述	test-description
ReportGranularity	string	報告彙總粒度	AllInOne
ReportFileFormats	string	報告格式	excel
ReportLanguage	string	報告語言。支援 zh-CN、en-US。空值預設 en-US。	en-US
ReportScope	array<object>	報告範圍數組，用於選定審計報告中包含的規則範圍。數組中每個 ReportScope 之間是或邏輯，也就是加法邏輯。說明如數組大小為 2，第一個 ReportScope 指定規則 In cr-1，第二個 ReportScope 指定規則 In cr-2，則此報告圈定的規則範圍為 cr-1 和 cr-2。
	object	報告範圍
Key	string	報告範圍的鍵，當前支援： AggregatorId CompliancePackId RuleId	RuleId
Value	string	報告範圍的值。多個同類項，如多個規則 Id 支援用英文半形逗號(,)分隔。	cr-1,cr-2
MatchType	string	匹配邏輯，當前僅支援 In。	In
RequestId	string	請求 ID。	A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7

樣本

正常返回樣本

JSON格式

{
  "ReportTemplate": {
    "ReportTemplateId": "crt-xxx",
    "ReportTemplateName": "test-name",
    "SubscriptionFrequency": "0 0 0 * * ?",
    "ReportTemplateDescription": "test-description",
    "ReportGranularity": "AllInOne",
    "ReportFileFormats": "excel",
    "ReportLanguage": "en-US",
    "ReportScope": [
      {
        "Key": "RuleId",
        "Value": "cr-1,cr-2",
        "MatchType": "In"
      }
    ]
  },
  "RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ReportTemplateNotExist	Report template does not exist or invalid.	報告模版不存在，請檢查輸入的ReportTemplateId
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	服務不可用。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。