ListApplications - 適用於 SQL 應用程式的 Amazon Kinesis Data Analytics 開發人員指南

針對新專案,我們建議您優先選擇新的 Managed Service for Apache Flink Studio,而非 Kinesis Data Analytics for SQL 應用程式。Managed Service for Apache Flink Studio 易於使用且具備進階分析功能,可讓您在幾分鐘內建置複雜的串流處理應用程式。

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

ListApplications

注意

此文件適用於 Amazon Kinesis Data Analytics API 第 1 版,僅支援 SQL 應用程式。第 2 版的 API 則支援 SQL 和 Java 應用程式。如需第 2 版的詳細資訊,請參閱 Amazon Kinesis Data Analytics API V2 文件

傳回您帳戶中的 Amazon Kinesis Analytics 應用程式清單。在每個應用程式,回應包括應用程式名稱、Amazon Resource Name (ARN),以及狀態。如果回應傳回 HasMoreApplications 值為 true,您可以傳送另一個要求,方法為在請求內文中加入 ExclusiveStartApplicationName,並將此值設定為先前回應的最後一個應用程式名稱。

如果您想要特定應用程式的詳細資訊,請使用 DescribeApplication

這項操作需要許可來執行 kinesisanalytics:ListApplications 動作。

請求語法

{ "ExclusiveStartApplicationName": "string", "Limit": number }

請求參數

請求接受採用 JSON 格式的下列資料。

ExclusiveStartApplicationName

清單開頭的應用程式名稱。使用分頁來擷取列表時,您不必在第一個請求中指定此參數。不過,在後續請求中,您可以新增先前回應中的最後一個應用程式名稱,以取得應用程式的下一頁。

類型:字串

長度限制:長度下限為 1。長度上限為 128。

模式:[a-zA-Z0-9_.-]+

必要:否

Limit

要列出的應用程式數目上限。

類型:整數

有效範圍:最小值為 1。最大值為 50。

必要:否

回應語法

{ "ApplicationSummaries": [ { "ApplicationARN": "string", "ApplicationName": "string", "ApplicationStatus": "string" } ], "HasMoreApplications": boolean }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

ApplicationSummaries

ApplicationSummary 物件的清單。

類型:ApplicationSummary 物件陣列

HasMoreApplications

如有更多應用程式可擷取,則傳回 true。

類型:布林值

另請參閲

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: