OpenSearch API でクォータレビュータスクをクエリ - OpenSearch

指定された 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:DescribeApp

*AppGroup

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

なし

リクエスト構文

GET /v4/openapi/app-groups/{appGroupIdentity}/quota-review-tasks HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
appGroupIdentity	string	必須	アプリケーショングループの名前。	"my_app_name"

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
pageNumber	integer	任意	ページ番号。デフォルト値は 1 です。	1
pageSize	integer	任意	各ページで返されるエントリ数。デフォルト値は 10 です。	10

リクエストの例:

GET /v4/openapi/app-groups/demo/quota-review-tasks

レスポンスフィールド

フィールド	型	説明	例
	object	応答オブジェクト。
totalCount	integer	エントリの総数。	500
requestId	string	リクエスト ID。	"3351A21F-705B-508C-9450-DA65A681547F"
result	array<object>	承認チケットに関する情報。詳細については、「QuotaReviewTask」をご参照ください。	[]
	object	結果オブジェクト。	{}
oldDocSize	integer	元のストレージ容量。	900
pending	boolean	タスクが保留中かどうかを示します。	false
memo	string	備考。	null
approved	boolean	タスクが承認されたかどうかを示します。	true
oldSpec	string	アプリケーションの元の仕様。	"opensearch.private.common"
oldComputeResource	integer	元の計算リソース。	500
appGroupType	string	アプリケーションタイプ。	"standard"
available	boolean	リソースがアクティブかどうかを示します。	true
gmtCreate	string	タスクが作成された時間。	"2020-04-08T08:29:45+0000"
newSocSize	integer	ターゲットのストレージ容量。	1100
id	integer	チケット ID。	142
appGroupId	integer	アプリケーション ID。	120123456
newComputeResource	integer	ターゲットの計算リソース。	6000
appGroupName	string	アプリケーション名。	"td_test_os"
gmtModified	string	最終変更時刻。	"2020-04-08T08:36:36+0000"
newSpec	string	新しいアプリケーション仕様。	"opensearch.private.common"

レスポンスの例:

{
    "id": 142,
    "appGroupId": 120577535,
    "appGroupName": "td_trade_order_os",
    "appGroupType": "standard",
    "oldSpec": "opensearch.private.common",
    "oldComputeResource": 500,
    "oldDocSize": 900,
    "newSpec": "opensearch.private.common",
    "newComputeResource": 6000,
    "newSocSize": 1100,
    "memo": null,
    "available": true,
    "pending": false,
    "approved": true,
    "gmtCreate": "2020-04-08T08:29:45+0000",
    "gmtModified": "2020-04-08T08:36:36+0000"
}

例

成功レスポンス

JSONJSON

{
  "totalCount": 500,
  "requestId": "\"3351A21F-705B-508C-9450-DA65A681547F\"",
  "result": [
    {
      "oldDocSize": 900,
      "pending": false,
      "memo": "null",
      "approved": true,
      "oldSpec": "\"opensearch.private.common\"",
      "oldComputeResource": 500,
      "appGroupType": "\"standard\"",
      "available": true,
      "gmtCreate": "\"2020-04-08T08:29:45+0000\"",
      "newSocSize": 1100,
      "id": 142,
      "appGroupId": 120123456,
      "newComputeResource": 6000,
      "appGroupName": "\"td_test_os\"",
      "gmtModified": "\"2020-04-08T08:36:36+0000\"",
      "newSpec": "\"opensearch.private.common\""
    }
  ]
}

エラーコード

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

変更履歴

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