调用ListApps接口，查看Elasticsearch Serverless应用的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| es-serverless:ListApps |
|
| 无 |
请求语法
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 |
| orderType | string | 否 | 按照应用创建时间的排序方式。默认 desc。
| desc |
返回参数
示例
正常返回示例
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",
"appType": ""
}
],
"requestId": "2C5DAA30-****-5181-9B87-9D6181016197"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |