ListApps - 应用列表_检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调用ListApps接口，查看Elasticsearch Serverless应用的列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /openapi/es-serverless/instances

请求参数

名称	类型	必填	描述	示例值
appName	string	否	应用名称。	es-severless-test-app
description	string	否	应用描述信息。	metrics-logs-online
pageNumber	integer	否	分页查询时设置的页码。	1
pageSize	integer	否	每页大小。	10
createTime	string	否	应用创建时间。过滤出大于等于输入值的应用，时间格式为 YYYY-MM-DDThh:mm:ssZ。	2023-08-29T02:37:22Z
status	string	否	应用状态： ACTIVE：正常 INIT：创建中 INACTIVE：冻结	ACTIVE
orderType	string	否	按照应用创建时间的排序方式。默认 desc。 asc：升序 desc：降序	desc

返回参数

名称	类型	描述	示例值
	object	响应体结构。
totalCount	integer	总记录数。	4
result	object []	数组，返回示例目录。
appName	string	应用名称。	es-severless-test-app
ownerId	string	应用所属的阿里云主账号 UID。	*********7595
regionId	string	地域 ID	cn-hangzhou
status	string	应用状态。	ACTIVE
createTime	string	创建时间。	2022-12-27T07:09:11.000Z
modifiedTime	string	更新时间。	2022-12-27T07:09:11.000Z
description	string	应用备注。	这是一个demo应用
appId	string	应用 ID。	test-abc
instanceId	string	实例 ID。	es-serverless-*17位id
version	string	产品版本。	7.10
requestId	string	请求 ID。	2C5DAA30-****-5181-9B87-9D6181016197

示例

正常返回示例

JSON格式

{
  "totalCount": 4,
  "result": [
    {
      "appName": "es-severless-test-app\n",
      "ownerId": "*********7595",
      "regionId": "cn-hangzhou",
      "status": "ACTIVE",
      "createTime": "2022-12-27T07:09:11.000Z",
      "modifiedTime": "2022-12-27T07:09:11.000Z\n",
      "description": "这是一个demo应用",
      "appId": "test-abc",
      "instanceId": "es-serverless-***17位id**",
      "version": "7.10"
    }
  ],
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197"
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史