すべてのプロダクト
Search

このプロダクト

    OpenSearch:DescribeAppGroup

    ドキュメントセンター

    OpenSearch:DescribeAppGroup

    最終更新日: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:DescribeAppGroup

    get

    *AppGroup

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

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    appGroupIdentity

    string

    必須

    アプリケーション名。

    my_app_group_name

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエスト ID。

    0A6EB64B-B4C8-CF02-810F-E660812972FF
    result

    object

    アプリケーションに関する情報。

    created

    integer

    アプリケーションが作成されたときのタイムスタンプ。

    1575442875
    currentVersion

    string

    現在のオンラインバージョンの ID。

    110116134
    pendingSecondRankAlgoDeploymentId

    integer

    作成中の高度ソート式の ID。

    0
    lockMode

    string

    ロック状態。有効な値：

    • Unlock：インスタンスはロックされていません。

    • LockByExpiration：インスタンスは有効期限が切れると自動的にロックされます。

    • ManualLock：インスタンスは手動でロックされます。

    Unlock
    updated

    integer

    アプリケーションが最後に更新されたときのタイムスタンプ。

    1578916076
    id

    string

    アプリケーション ID。

    110116134
    chargeType

    string

    課金方法。有効な値：

    • POSTPAY：従量課金。

    • PREPAY：サブスクリプション。

    POSTPAY
    hasPendingQuotaReviewTask

    integer

    クォータの承認状態。有効な値：

    • 0：アプリケーションはサービス中です。

    • 1：クォータはレビュー中です。

    0
    secondRankAlgoDeploymentId

    integer

    作成された高度ソート式の ID。

    0
    name

    string

    アプリケーション名。

    os_function_test_v1
    instanceId

    string

    インスタンス ID。

    -
    processingOrderId

    string

    未完了の注文の ID。

    -
    chargingWay

    integer

    課金項目。有効な値：

    • 1：コンピューティングリソース。

    • 2：1 秒あたりのクエリ数 (QPS)。

    1
    type

    string

    アプリケーションのタイプ。有効な値：

    • standard：高性能検索版アプリケーション。

    • enhanced：業界アルゴリズム版アプリケーション。

    enhanced
    status

    string

    アプリケーションの状態。有効な値：

    • producing：アプリケーションは作成中です。

    • review_pending：アプリケーションはレビュー中です。

    • config_pending：アプリケーションは設定保留中です。

    • normal：アプリケーションはサービス中です。

    • frozen：アプリケーションは凍結されています。

    normal
    projectId

    string

    A/B テストグループの名前。

    -
    switchedTime

    integer

    現在のオンラインバージョンが公開されたときのタイムスタンプ。

    0
    commodityCode

    string

    商品コード。

    opensearch
    expireOn

    string

    有効期限。

    -
    domain

    string

    アプリケーションの業界。

    ecommerce
    description

    string

    アプリケーションの説明。

    -
    firstRankAlgoDeploymentId

    integer

    作成された基本ソート式の ID。

    0
    produced

    integer

    アプリケーションが作成されたかどうかを示します。有効な値：

    • 0：アプリケーションは作成中です。

    • 1：アプリケーションは作成済みです。

    1
    lockedByExpiration

    integer

    インスタンスが有効期限切れ後に自動的にロックされるかどうかを示します。

    0
    quota

    object

    アプリケーションのクォータに関する情報。

    spec

    string

    仕様。有効な値：

    • opensearch.share.junior：ベーシック。

    • opensearch.share.common：共有汎用。

    • opensearch.share.compute：共有コンピューティング。

    • opensearch.share.storage：共有ストレージ。

    • opensearch.private.common：排他的汎用。

    • opensearch.private.compute：排他的コンピューティング。

    • opensearch.private.storage：排他的ストレージ。

    opensearch.share.common
    docSize

    integer

    ストレージ容量。単位：GB。

    1
    computeResource

    integer

    コンピューティングリソース。単位：論理コンピューティングユニット (LCU)。

    20
    tags

    array<object>

    アプリケーションのタグ。

    object

    key

    string

    タグキー。

    foo
    value

    string

    タグ値。

    bar
    resourceGroupId

    string

    ネットワークインスタンスが属するリソースグループの ID。

    rg-acfmoiyerh6nzly
    engineType

    string

    エンジンタイプ。

    ha3

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": {
    "created": 1575442875,
    "currentVersion": "110116134",
    "pendingSecondRankAlgoDeploymentId": 0,
    "lockMode": "Unlock",
    "updated": 1578916076,
    "id": "110116134",
    "chargeType": "POSTPAY",
    "hasPendingQuotaReviewTask": 0,
    "secondRankAlgoDeploymentId": 0,
    "name": "os_function_test_v1",
    "instanceId": "-",
    "processingOrderId": "-",
    "chargingWay": 1,
    "type": "enhanced",
    "status": "normal",
    "projectId": "-",
    "switchedTime": 0,
    "commodityCode": "opensearch",
    "expireOn": "-",
    "domain": "ecommerce",
    "description": "-",
    "firstRankAlgoDeploymentId": 0,
    "produced": 1,
    "lockedByExpiration": 0,
    "quota": {
      "spec": "opensearch.share.common",
      "docSize": 1,
      "computeResource": 20
    },
    "tags": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "resourceGroupId": "rg-acfmoiyerh6nzly",
    "engineType": "ha3"
  }
}

    エラーコード

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

    変更履歴

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