ListApps - 查看Serverless应用列表

更新时间: 2023-07-27 16:46:28

查看Serverless应用列表。

接口说明

获取应用列表。

调试

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

调试

授权信息

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

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

请求语法

GET /openapi/xops/instances

请求参数

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

应用名称

es-severless-test-app
descriptionstring

应用备注描述信息。

metrics-logs-online
pageNumberinteger

分页查询时设置的页码。

2
pageSizeinteger

返回结果的分页数。默认值:20,最小值:1,最大值:50。

20

返回参数

名称类型描述示例值
object

Schema of Response

totalCountinteger

总应用数。

68
resultobject []

数组,返回示例目录。

appNamestring

应用名称。(主键)

es-severless-test-app
ownerIdstring

应用所属的阿里云主账号UID。

*********7595
storageQuotastring

存储限流额。

***
regionIdstring

地域ID。

cn-hangzhou
statusstring

应用服务的状态:

  • ACTIVE
  • INACTIVE
ACTIVE
createTimestring

应用创建时间。

2022-12-27T07:09:11.000Z
flowQuotastring

流量限流额。

***
descriptionstring

应用备注信息。

应用备注名abc
requestIdstring

请求ID。

2C5DAA30-****-5181-9B87-9D6181016197

示例

正常返回示例

JSON格式

{
  "totalCount": 68,
  "result": [
    {
      "appName": "es-severless-test-app\n",
      "ownerId": "*********7595",
      "storageQuota": "***",
      "regionId": "cn-hangzhou",
      "status": "ACTIVE",
      "createTime": "2022-12-27T07:09:11.000Z",
      "flowQuota": "***",
      "description": "应用备注名abc"
    }
  ],
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197"
}

错误码

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

阿里云首页 检索分析服务 Elasticsearch版 相关技术圈