SAE アプリケーションイベント用 ListAppEvents API リファレンス - SAE - Alibaba Cloud - Serverless App Engine

アプリケーションイベントを一覧表示するには、ListAppEvents API を呼び出します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:ListAppEvents

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/app/listAppEvents HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CurrentPage	integer	任意	現在のページ番号。	1
PageSize	integer	任意	1 ページあたりに返すエントリ数。値は 0 から 10,000 までの整数である必要があります。	10
AppId	string	任意	アプリケーション ID。	f7730764-d88f-4b9a-8d8e-cd8efbfe****
ObjectKind	string	任意	オブジェクトの種類。有効な値： Deployment：アプリケーション。 Pod：アプリケーションインスタンス。 Service：Server Load Balancer (SLB) インスタンス。 HorizontalPodAutoscaler：自動スケーリングポリシー。 CloneSet：アプリケーション。	Pod
ObjectName	string	任意	オブジェクト名。プレフィックスマッチングをサポートしています。	errew-b86bf540-b4dc-47d8-a42f-b4997c14bd8f-5595cbddd6-x****
EventType	string	任意	イベントタイプ。有効な値： Warning：潜在的な問題を示すイベント。 Normal：通常の操作を示すイベント。	Warning
Reason	string	任意	イベントの理由。プレフィックスマッチングをサポートしています。	Started
Namespace	string	必須	名前空間が配置されているリージョンの ID。	cn-beijing

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストに対して返されるデータ。
Message	string	リクエスト結果に関する追加情報。	success
RequestId	string	リクエスト ID。	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	イベントリスト。
CurrentPage	integer	現在のページ番号。	1
AppEventEntity	array<object>	アプリケーションイベントの配列。
	object	単一のイベントオブジェクト。
ObjectKind	string	オブジェクトの種類。	Pod
EventType	string	イベントタイプ。	Normal
LastTimestamp	string	イベントが最後に発生したときのタイムスタンプ。	2020-02-19T05:01:28Z
Message	string	イベントメッセージ。	Created container
ObjectName	string	オブジェクト名。	errew-b86bf540-b4dc-47d8-a42f-b4997c14bd8f-5595cbddd6-2****
Reason	string	イベントの理由。	Created
FirstTimestamp	string	イベントが最初に発生したときのタイムスタンプ。	2020-02-19T05:01:28Z
CauseAnalysis	string	原因分析。
TotalSize	integer	アプリケーションイベントの総数。	20
PageSize	integer	1 ページあたりに返されるエントリ数。	10
ErrorCode	string	エラーコード。リクエストが成功した場合、ErrorCode パラメーターは返されません。リクエストが失敗した場合、ErrorCode パラメーターが返されます。詳細については、エラーコードのセクションをご参照ください。
Code	string	リクエストに対して返される HTTP ステータスコード。有効な値： 2xx：成功。 3xx：リダイレクト。 4xx：クライアントエラー。 5xx：サーバーエラー。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "AppEventEntity": [
      {
        "ObjectKind": "Pod",
        "EventType": "Normal",
        "LastTimestamp": "2020-02-19T05:01:28Z",
        "Message": "Created container",
        "ObjectName": "errew-b86bf540-b4dc-47d8-a42f-b4997c14bd8f-5595cbddd6-2****",
        "Reason": "Created",
        "FirstTimestamp": "2020-02-19T05:01:28Z",
        "CauseAnalysis": ""
      }
    ],
    "TotalSize": 20,
    "PageSize": 10
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	get.event.error	Failed to obtain event information.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.

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

変更履歴

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