文档

DescribeApp - 查看一个应用版本详情

更新时间:

查看一个 OpenSearch 应用版本详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
opensearch:DescribeApp
  • App
    acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

请求语法

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

请求参数

名称类型必填描述示例值
appGroupIdentitystring

应用名称

my_app_group_name
appIdinteger

版本 ID

110116134

返回参数

名称类型描述示例值
object

响应体

requestIdstring

请求 ID

33477D76-C380-1D84-A4AD-043F52876CB1
resultobject

版本信息

createdinteger

版本创建时间戳

1590977140
clusterNamestring

集群名称

-
autoSwitchboolean

是否自动切换

true
algoDeploymentIdinteger

粗排部署 ID

0
typestring

版本类型

  • standard 标准版
  • advance 老高级版(新应用不支持此类型)
  • enhanced 新高级版
enhanced
descriptionstring

版本描述

-
statusstring

版本状态

  • ok 正常
  • stopped 暂停
  • frozen 已冻结
  • initializing 版本初始化中
  • unavailable 版本已失效
  • data_waiting 等待数据初始化
  • data_preparing 数据初始化中
ok
schemaobject

应用结构

{}
progressPercentinteger

数据导入进度百分比(如 83 代表 83%)

100
idstring

版本 ID

100303063
fetchFieldsarray

默认展示字段

string

默认展示字段

{}
quotaobject

配额信息

specstring

规格

  • opensearch.share.junior 入门型
  • opensearch.share.common 共享通用型
  • opensearch.share.compute 共享计算型
  • opensearch.share.storage 共享存储型
  • opensearch.private.common 独享通用型
  • opensearch.private.compute 独享计算型
  • opensearch.private.storage 独享存储型
opensearch.share.common
qpsinteger

搜索请求(单位:次/秒)(老计费模型使用)

5
docSizeinteger

存储容量(单位:GB)

1
computeResourceinteger

计算资源(单位:LCU)

20
domainobject

行业类型

  • GENERAL 通用
  • ECOMMERCE 电商
  • IT_CONTENT IT 内容
categorystring

类型-standard 标准版-advance 老高级版(新应用不支持此类型)-enhanced 新高级版

-
namestring

英文名称

test
functionsobject

搜索结果

servicearray

各个功能说明

string

功能 1

-
qparray

布局信息

string

信息 1

-
algoarray

算法结构

string

结构 1

-

示例

正常返回示例

JSON格式

{
  "requestId": "33477D76-C380-1D84-A4AD-043F52876CB1",
  "result": {
    "created": 1590977140,
    "clusterName": "-",
    "autoSwitch": true,
    "algoDeploymentId": 0,
    "type": "enhanced",
    "description": "-",
    "status": "ok",
    "schema": {},
    "progressPercent": 100,
    "id": "100303063",
    "fetchFields": [
      "{}"
    ],
    "quota": {
      "spec": "opensearch.share.common",
      "qps": 5,
      "docSize": 1,
      "computeResource": 20
    },
    "domain": {
      "category": "-",
      "name": "test",
      "functions": {
        "service": [
          "-"
        ],
        "qp": [
          "-"
        ],
        "algo": [
          "-"
        ]
      }
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史