文档

ListAppGroups - 获取应用列表

更新时间:

获取OpenSearch应用列表。

接口说明

  • 支持按照 name、instanceId、type 进行过滤
  • 支持按照应用的创建时间排序
  • 支持分页参数

调试

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

授权信息

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

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

请求语法

GET /v4/openapi/app-groups

请求参数

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

页码,默认 pageNumber=1

1
pageSizeinteger

每页返回数目,默认 pageSize=10

10
instanceIdstring

实例 ID(精确匹配)

ops-cn-xxxx
namestring

应用名称

my_name
typestring

应用类型

  • standard 标准版
  • enhanced 新高级版
standard
sortByinteger

排列顺序

  • 0:按创建时间降序排列
  • 1:按修改时间降序排列

默认 sortBy=0

0
resourceGroupIdstring

资源 id

"110123123"
tagsarray<object>

标签列表

object
keystring

标签键

foo
valuestring

标签值

bar

返回参数

名称类型描述示例值
object

响应体

totalCountinteger

总条数

1
requestIdstring

请求 ID

0A6EB64B-B4C8-CF02-810F-E660812972FF
resultarray<object>

应用信息

参考: AppGroup

[]
object

结果体

createdinteger

创建时间戳

1575442875
currentVersionstring

当前在线版本

110116134
lockModestring

锁定状态

  • Unlock 正常
  • LockByExpiration 实例过期自动锁定
  • ManualLock 手动触发锁定
Unlock
updatedinteger

更新时间戳

1578916076
idstring

应用 ID

110116134
chargeTypestring

付费类型

  • POSTPAY 后付费(按量付费)
  • PREPAY 预付费(包年包月)
POSTPAY
hasPendingQuotaReviewTaskinteger

是否配额审批中

  • 0:正常
  • 1:配额审批中
0
namestring

应用名称

os_function_test_v1
instanceIdstring

实例 ID

"xxx"
chargingWayinteger

计费类型

  • 1:计算资源
  • 2:qps
1
typestring

应用类型

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

应用状态

  • producing 生产中
  • review_pending 生产审批中
  • config_pending 待配置
  • normal 正常
  • frozen 已冻结
normal
projectIdstring

abtest project 名称

"xxx"
switchedTimeinteger

在线版本切换时间戳

0
commodityCodestring

商品 CODE

opensearch
expireOnstring

过期时间

"xxx"
domainstring

domain

""
descriptionstring

应用描述

"xxx"
producedinteger

是否生产完成

  • 0:生产中
  • 1:生产完成
1
lockedByExpirationinteger

实例过期自动锁定

0
quotaobject

应用配额信息 参考: Quota

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
docSizeinteger

存储容量(单位:GB)

1
computeResourceinteger

计算资源(单位:LCU)

20
tagsarray<object>

应用标签

object

标签。

keystring

标签键

foo
valuestring

标签值

bar

示例

正常返回示例

JSON格式

{
  "totalCount": 1,
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "created": 1575442875,
      "currentVersion": "110116134",
      "lockMode": "Unlock",
      "updated": 1578916076,
      "id": "110116134",
      "chargeType": "POSTPAY",
      "hasPendingQuotaReviewTask": 0,
      "name": "os_function_test_v1",
      "instanceId": "\"xxx\"",
      "chargingWay": 1,
      "type": "enhanced",
      "status": "normal",
      "projectId": "\"xxx\"",
      "switchedTime": 0,
      "commodityCode": "opensearch",
      "expireOn": "\"xxx\"",
      "domain": "\"\"",
      "description": "\"xxx\"",
      "produced": 1,
      "lockedByExpiration": 0,
      "quota": {
        "spec": "opensearch.share.common",
        "docSize": 1,
        "computeResource": 20
      },
      "tags": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "engineType": ""
    }
  ]
}

错误码

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