GetTrailStatus によるトレイルステータスのクエリ - ActionTrail - Alibaba Cloud - ActionTrail

トレイルのステータスを照会します。

操作説明

この Topic では、シングルアカウントトレイル trail-test のステータスを照会する方法の例を示します。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

actiontrail:GetTrailStatus

get

*Trail。

acs:actiontrail:{#regionId}:{#accountId}:trail/{#TrailName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Name	string	必須	トレイルの名前です。名前は 6～36 文字で、小文字で始まる必要があり、小文字、数字、ハイフン (-)、アンダースコア (_) を含めることができます。説明トレイル名はアカウント内で一意である必要があります。	trail-test
IsOrganizationTrail	boolean	任意	マルチアカウントトレイルのステータスを照会するかどうかを指定します。有効な値: true: マルチアカウントトレイルのステータスを照会します。 false (デフォルト): シングルアカウントトレイルのステータスを照会します。	false

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object
IsLogging	boolean	ログレコードが有効かどうかを示します。有効な値: true: 有効。 false: シャットダウン。	true
LatestDeliveryError	string	直近のトレイル例外のログ情報です。	write sls failed, exception: the parent of sub user must be project owner, itemscount: 1
LatestDeliveryLogServiceError	string	Simple Log Service サービスへの配信時に発生した直近のエラーのエラーメッセージです。	write sls failed, exception: the parent of sub user must be project owner, itemscount: 1
LatestDeliveryLogServiceTime	string	トレイルが Simple Log Service サービスにイベントを配信した直近の時間です。時間は ISO 8601 標準に従い、協定世界時 (UTC) の yyyy-MM-dd'T'HH:mm:ss'Z' フォーマットです。	2021-02-26T09:19:44Z
LatestDeliveryTime	string	イベントが正常に配信された直近の時間です。時間は ISO 8601 標準に従い、協定世界時 (UTC) の yyyy-MM-dd'T'HH:mm:ss'Z' フォーマットです。	2021-02-26T09:19:44Z
OssBucketStatus	boolean	OSS バケットが利用可能かどうかを示します。有効な値: true: 利用可能。 false: 利用不可。	true
RequestId	string	リクエスト ID です。	8067369B-B923-4D26-85BC-61BF33922505
SlsLogStoreStatus	boolean	SLS Logstore が利用可能かどうかを示します。有効な値: true: 利用可能。 false: 利用不可。	true
StartLoggingTime	string	トレイルがイベントの記録を開始した直近の時間です。時間は ISO 8601 標準に従い、協定世界時 (UTC) の yyyy-MM-dd'T'HH:mm:ss'Z' フォーマットです。	2021-02-24T09:19:44Z
StopLoggingTime	string	トレイルがイベントの記録を停止した直近の時間です。時間は ISO 8601 標準に従い、協定世界時 (UTC) の yyyy-MM-dd'T'HH:mm:ss'Z' フォーマットです。	2021-02-25T09:19:44Z

例

成功レスポンス

JSONJSON

{
  "IsLogging": true,
  "LatestDeliveryError": "write sls failed, exception: the parent of sub user must be project owner, itemscount: 1",
  "LatestDeliveryLogServiceError": "write sls failed, exception: the parent of sub user must be project owner, itemscount: 1",
  "LatestDeliveryLogServiceTime": "2021-02-26T09:19:44Z",
  "LatestDeliveryTime": "2021-02-26T09:19:44Z",
  "OssBucketStatus": true,
  "RequestId": "8067369B-B923-4D26-85BC-61BF33922505",
  "SlsLogStoreStatus": true,
  "StartLoggingTime": "2021-02-24T09:19:44Z",
  "StopLoggingTime": "2021-02-25T09:19:44Z"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	TrailNotFoundException	The specified Trail does not exist.	The specified Trail is not existed.

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

変更履歴

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