すべてのプロダクト
Search
ドキュメントセンター

OpenSearch:DescribeAppStatistics

最終更新日:Dec 23, 2025

OpenSearch アプリケーションの特定バージョンの統計情報を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

opensearch:DescribeAppStatistics

*App

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

なし なし

リクエスト構文

GET /v4/openapi/app-groups/{appGroupIdentity}/apps/{appId}/statistics HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

appGroupIdentity

string

必須

アプリケーション名。

my_app_group_name

appId

string

必須

アプリケーションのバージョン番号。

110157886

リクエストパラメーター

パラメーター

必須 / 任意

説明

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド

説明

object

result

object

統計情報。

{}

requestId

string

リクエスト ID。

76FC45F1-4167-D3CD-6737-4F97BA503FA0

統計結果

パラメータータイプ説明
result.pvIntegerリクエスト数。
result.docCountIntegerドキュメント数。
result.docLastUpdatedStringドキュメントが最後に更新されたときのタイムスタンプ。
result.quotaObjectクォータに関する統計情報。
result.quota.instanceObjectインスタンスに関する統計情報。
result.quota.instance.usedFloat使用済みクォータ。単位: LCU。
result.quota.instance.quotaIntegerクォータ容量。単位: GB。
result.quota.instance.outOfLimitBooleanクォータを超過したかどうかを示します。
result.quota.instance.tablesObject各データテーブルで使用される統計情報。キー名はテーブル名で、値は使用容量です。
result.quota.qpsObject1 秒あたりのクエリ数 (QPS) のクォータに関する統計情報。
result.quota.qps.usedFloat使用済みの QPS クォータ。
result.quota.qps.quotaIntegerQPS の合計クォータ。
result.quota.qps.outOfLimitBooleanクォータを超過したかどうかを示します。
result.quota.qps.tablesArray--
result.quota.computeResourceObjectコンピューティングリソースのクォータに関する統計情報。
result.quota.computeResource.usedFloat使用済みのコンピューティングリソース。単位: LCU。
result.quota.computeResource.quotaIntegerコンピューティングリソースのクォータ。単位: GB。
result.quota.computeResource.outOfLimitBooleanクォータを超過したかどうかを示します。
result.quota.computeResource.dailyPeakFloat使用されたコンピューティングリソースの最大量。単位: LCU。
result.quota.specStringアプリケーションの仕様。有効な値:opensearch.share.junior:基本、opensearch.share.common:共有汎用、opensearch.share.compute:共有コンピューティング、opensearch.share.storage:共有ストレージ、opensearch.private.common:専用汎用、opensearch.private.compute:専用コンピューティング、opensearch.private.storage:専用ストレージ
result.quota.docCountObjectドキュメント数の統計情報。キーはテーブル名を示し、値は使用済みクォータを示します。
result.quota.mainTableStringプライマリテーブルの名前。

成功レスポンス

JSONJSON

{
  "result": {},
  "requestId": "76FC45F1-4167-D3CD-6737-4F97BA503FA0"
}

エラーコード

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

変更履歴

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