全部产品
云市场
云游戏

ListAppGroups

更新时间:2020-07-23 17:12:48

描述

获取 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

示例

请求示例

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

返回示例

正确返回

  1. {
  2. "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  3. "totalCount": 1,
  4. "result": [
  5. {
  6. "id": "110116134",
  7. "name": "os_function_test_v1",
  8. "currentVersion": "110116134",
  9. "switchedTime": 0,
  10. "quota": {
  11. "docSize": 1,
  12. "computeResource": 20,
  13. "spec": "opensearch.share.common"
  14. },
  15. "chargingWay": 1,
  16. "type": "enhanced",
  17. "projectId": "",
  18. "chargeType": "POSTPAY",
  19. "expireOn": "",
  20. "instanceId": "",
  21. "commodityCode": "opensearch",
  22. "processingOrderId": "",
  23. "firstRankAlgoDeploymentId": 0,
  24. "secondRankAlgoDeploymentId": 0,
  25. "pendingSecondRankAlgoDeploymentId": 0,
  26. "description": "",
  27. "produced": 1,
  28. "lockedByExpiration": 0,
  29. "hasPendingQuotaReviewTask": 0,
  30. "created": 1575442875,
  31. "updated": 1578916076,
  32. "status": "normal",
  33. "lockMode": "Unlock"
  34. }
  35. ]
  36. }


错误返回
参考:响应结构