ListAppGroups_应用管理_管控API参考_开发指南

描述

获取 OpenSearch 应用列表。

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

方法

GET

URI

/v4/openapi/app-groups

请求参数

查询参数

名称	类型	是否必选	示例值	描述
name	String	否	“my_name”	应用名称
instanceId	String	否	“ops-cn-xxxx”	实例ID（精确匹配）
type	String	否	“standard”	应用类型 - standard 标准版 - enhanced 新高级版
sortBy	Integer	否	0	排列顺序 - 0：按创建时间降序排列 - 1：按修改时间降序排列默认 sortBy=0
pageNumber	Integer	否	1	页码，默认 pageNumber=1
pageSize	Integer	否	10	每页返回数目，默认 pageSize=10

返回参数

字段	类型	描述
requestId	String	请求ID
result[]	Object	应用信息参考：AppGroup

示例

请求示例

GET /v4/openapi/app-groups?type=enhanced&sortBy=1

返回示例

正确返回

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

错误返回
参考：响应结构