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

コンプライアンスレポートテンプレートの詳細を取得します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ReportTemplateId	string	必須	レポートテンプレートの ID。	crt-xxx

レスポンスフィールド

フィールド	型	説明	例
	object
ReportTemplate	object	レポートテンプレート。
ReportTemplateId	string	レポートテンプレートの ID。	crt-xxx
ReportTemplateName	string	レポートテンプレートの名前。	test-name
SubscriptionFrequency	string	レポートのサブスクリプション周波数。このフィールドが空でない場合、通知をトリガーする Quartz 形式の cron 式が含まれます。形式は次のとおりです: seconds minutes hours day-of-month month day-of-week。一般的な例は次のとおりです。毎日 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 0 * * ?
ReportTemplateDescription	string	レポートテンプレートの説明。	test-description
ReportGranularity	string	レポートの集計粒度。	AllInOne
ReportFileFormats	string	レポートファイル形式。	excel
ReportLanguage	string	レポート言語。有効な値: zh-CN および en-US。空の場合、デフォルトは en-US です。	en-US
ReportScope	array<object>	レポートスコープの配列。各スコープは、監査レポートに含まれるルールセットを定義します。スコープは 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
RequestId	string	リクエスト ID。	A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7

例

成功レスポンス

JSONJSON

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

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

変更履歴

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