全部產品
Search

搜尋本產品

    Cloud Config：ListReportTemplates - 批量擷取合規報告模版詳情

    文件中心

    Cloud Config：ListReportTemplates - 批量擷取合規報告模版詳情

    更新時間：Feb 05, 2026

    批量擷取合規報告模版詳情。

    調試

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

    調試

    授權資訊

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    NextToken

    string

    否

    當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，擷取從當前截斷位置之後的內容。

    IWBjqMYSy0is7zSMGu16****
    MaxResults

    integer

    否

    分批次查詢時，每次顯示的條目數。預設 20。

    20
    Keyword

    string

    否

    查詢關鍵字。

    支援對模版 ID、模版名稱、模版描述進行模糊查詢。

    test-description

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    8195B664-9565-4685-89AC-8B5F04B44B92
    TotalCount

    integer

    模板總數。

    7
    MaxResults

    integer

    分頁大小，取值範圍：1~50，預設值：20。

    20
    NextToken

    string

    當請求的返回結果被截斷時，您可以使用 NextToken 再次發起請求，擷取從當前截斷位置之後的內容。

    aVCjqNaSy0Ps7zSMGu25****
    ReportTemplateList

    array<object>

    報告模版列表

    array<object>

    ReportTemplateId

    string

    報告模版 Id

    crt-xxx
    ReportTemplateName

    string

    報告模版名稱

    test-name
    ReportTemplateDescription

    string

    報告模版描述

    test-description
    ReportGranularity

    string

    報告彙總粒度。

    管理帳號視角支援：

    • AllInOne(模版範圍所有帳號彙總產生一份報告)

    • GroupByAggregator(按照帳號組彙總產生報告，產生一個壓縮檔)

    • GroupByAccount(所有帳號單獨產生報告(預設)，產生一個壓縮檔)

    成員帳號只支援 GroupByAccount。

    AllInOne
    ReportFileFormats

    string

    報告格式，當前僅支援 excel 。

    excel
    ReportLanguage

    string

    報告語言。支援 zh-CN、en-US。空值預設 en-US。

    en-US
    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 13 * * ?
    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

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "8195B664-9565-4685-89AC-8B5F04B44B92",
  "TotalCount": 7,
  "MaxResults": 20,
  "NextToken": "aVCjqNaSy0Ps7zSMGu25****",
  "ReportTemplateList": [
    {
      "ReportTemplateId": "crt-xxx",
      "ReportTemplateName": "test-name",
      "ReportTemplateDescription": "test-description",
      "ReportGranularity": "AllInOne",
      "ReportFileFormats": "excel",
      "ReportLanguage": "en-US",
      "SubscriptionFrequency": "0 0 13 * * ?",
      "ReportScope": [
        {
          "Key": "RuleId",
          "Value": "cr-1,cr-2",
          "MatchType": "In"
        }
      ]
    }
  ]
}

    錯誤碼

    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. 服務不可用。

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

    變更歷史

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