DescribeApps - 获取一个应用的版本列表

获取一个 OpenSearch 应用的版本列表。

调试

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

授权信息

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

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

请求语法

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

请求参数

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

应用名称

my_app_group_name

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID

77CAA411-0010-4DB9-82E2-1C384E590AFF
resultarray<object>

返回结果

resultobject

版本信息,参考: App

{}

示例

正常返回示例

JSON格式

{
  "requestId": "77CAA411-0010-4DB9-82E2-1C384E590AFF",
  "result": [
    {
      "id": "",
      "isCurrent": true,
      "clusterName": "",
      "autoSwitch": true,
      "type": "",
      "description": "",
      "status": "",
      "schema": {
        "tables": {
          "test": "test",
          "test2": 1
        },
        "indexes": {
          "filterFields": [
            ""
          ],
          "searchFields": {
            "test": "test",
            "test2": 1
          }
        },
        "routeField": "",
        "routeFieldValues": [
          ""
        ],
        "secondRouteField": "",
        "ttlField": {
          "name": "",
          "ttl": 0
        },
        "indexSortConfig": [
          {
            "field": "",
            "direction": ""
          }
        ],
        "name": ""
      },
      "progressPercent": 0,
      "fetchFields": [
        ""
      ],
      "quota": {
        "spec": "",
        "qps": 0,
        "docSize": 0,
        "computeResource": 0
      },
      "domain": {
        "category": "",
        "name": "",
        "functions": {
          "service": [
            ""
          ],
          "qp": [
            ""
          ],
          "algo": [
            ""
          ]
        }
      },
      "schemas": [
        {
          "tables": {
            "test": "test",
            "test2": 1
          },
          "indexes": {
            "filterFields": [
              ""
            ],
            "searchFields": {
              "test": "test",
              "test2": 1
            }
          },
          "routeField": "",
          "routeFieldValues": [
            ""
          ],
          "secondRouteField": "",
          "ttlField": {
            "name": "",
            "ttl": 0
          },
          "indexSortConfig": [
            {
              "field": "",
              "direction": ""
            }
          ],
          "name": ""
        }
      ],
      "firstRanks": [
        {
          "type": "",
          "name": "",
          "description": "",
          "active": true,
          "meta": ""
        }
      ],
      "secondRanks": [
        {
          "meta": "",
          "name": "",
          "description": "",
          "active": true
        }
      ],
      "dataSources": [
        {
          "tableName": "",
          "type": "",
          "fields": [
            {
              "test": "test",
              "test2": 1
            }
          ],
          "plugins": {
            "test": "test",
            "test2": 1
          },
          "keyField": "",
          "schemaName": "",
          "parameters": {
            "test": "test",
            "test2": 1
          }
        }
      ],
      "summaries": [
        {
          "name": "",
          "meta": [
            {
              "field": "",
              "len": 0,
              "element": "",
              "ellipsis": "",
              "snippet": ""
            }
          ]
        }
      ],
      "queryProcessors": [
        {
          "name": "",
          "domain": "",
          "category": "",
          "processors": [
            {
              "test": "test",
              "test2": 1
            }
          ],
          "indexes": [
            ""
          ],
          "active": true
        }
      ],
      "cluster": {
        "maxTimeoutMS": 0,
        "maxQueryClauseLength": 0
      },
      "interpretations": {
        "test": "test",
        "test2": 1
      },
      "prompts": [
        {
          "test": "test",
          "test2": 1
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-26OpenAPI 返回结构发生变更查看变更详情