ListReportTemplates - Cloud Config - Alibaba Cloud ドキュメントセンター

コンプライアンスレポートテンプレートの詳細をバッチで照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	応答が切り捨てられている場合、NextToken を使用して別のリクエストを送信し、切り捨てポイント以降の結果を取得します。	IWBjqMYSy0is7zSMGu16****
MaxResults	integer	任意	1 ページあたりに返されるエントリ数です。デフォルト値は 20 です。	20
Keyword	string	任意	検索キーワードです。テンプレート ID、テンプレート名、またはテンプレートの説明に対してあいまい検索を実行できます。	test-description

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	8195B664-9565-4685-89AC-8B5F04B44B92
TotalCount	integer	テンプレートの総数です。	7
MaxResults	integer	1 ページあたりに返されるエントリの最大数です。有効な値は 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：テンプレート範囲内のすべてのアカウントを集約して 1 つのレポートにします。 GroupByAggregator：アグリゲーターグループごとにレポートを生成します。出力は 1 つの圧縮ファイルになります。 GroupByAccount：各アカウントごとに個別のレポートを生成します（デフォルト）。出力は 1 つの圧縮ファイルになります。メンバーアカウントは GroupByAccount のみをサポートします。	AllInOne
ReportFileFormats	string	レポートのフォーマットです。Excel のみがサポートされています。	excel
ReportLanguage	string	レポートの言語です。有効な値は zh-CN および en-US です。デフォルト値は en-US です。	en-US
SubscriptionFrequency	string	レポートのサブスクリプション周波数です。このパラメーターを指定する場合は、Quartz 形式の cron 式である必要があります。形式は次のとおりです：秒分時日月曜日。一般的な例を以下に示します。毎日 00:00 に実行：0 0 0 * * ? 毎週月曜日 15:30 に実行：0 30 15 ? * MON 毎月 1 日 02:00 に実行：0 0 2 1 * ? ここで： "*" は任意の値を意味します。 "?" は日または曜日に特定の値を設定しないことを意味します。 "MON" は月曜日を意味します。説明時刻は UTC + 08:00 です。cron 式はご利用のローカルタイムゾーンに基づいて調整してください。説明システムはスケジュールされた時刻にレポートを実行しようと試みますが、レポート生成の遅延により実行が遅れる場合があります。各テンプレートは 1 日あたり最大 1 回の通知しかトリガーしません。説明 Quartz では、曜日は日曜日から始まる番号で表されます：1 = 日曜日、2 = 月曜日、3 = 火曜日、4 = 水曜日、5 = 木曜日、6 = 金曜日、7 = 土曜日。	0 0 13 * * ?
ReportScope	array<object>	監査レポートに表示されるルールを定義する配列です。各 ReportScope オブジェクトは OR 論理（加算論理）を使用します。説明たとえば、配列に 2 つの項目があり、最初の項目が RuleId cr-1 を指定し、2 番目の項目が RuleId cr-2 を指定している場合、レポートには cr-1 および cr-2 の両方が含まれます。
	object	レポート範囲の定義です。
Key	string	レポート範囲のキーです。サポートされている値は以下のとおりです。 AggregatorId CompliancePackId RuleId	RuleId
Value	string	レポート範囲の値です。同じタイプの複数の値（たとえば複数のルール ID）がある場合は、カンマ (,) で区切ります。	cr-1,cr-2
MatchType	string	マッチングロジックです。In のみがサポートされています。	In

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
400	ReportTemplateNotExist	Report template does not exist or invalid.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。