全部產品
Search

搜尋本產品

    OpenSearch：DescribeAppGroup

    文件中心

    OpenSearch：DescribeAppGroup

    更新時間：Jul 20, 2026

    檢視一個 OpenSearch 應用程式詳情。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值

    當前API無需請求參數

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    requestId

    string

    請求 ID。

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

    object

    應用程式資訊。

    created

    integer

    建立時間戳記。

    1575442875
    currentVersion

    string

    目前線上版本。

    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

    未結束訂單號。

    -
    chargingWay

    integer

    計費類型。

    • 1：運算資源

    • 2：qps

    1
    type

    string

    應用程式類型。

    • standard 標準版

    • enhanced 新進階版

    enhanced
    status

    string

    應用程式狀態。

    • producing 生產中

    • review_pending 生產審批中

    • config_pending 待設定

    • normal 正常

    • frozen 已凍結

    normal
    projectId

    string

    abtest project 名稱。

    -
    switchedTime

    integer

    線上版本切換時間戳記。

    0
    commodityCode

    string

    商品 CODE。

    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
    elasticLcu

    integer

    樣本

    正常返回樣本

    JSON格式

    {
  "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",
    "elasticLcu": 0
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。