获取OpenSearch应用列表。
接口说明
- 支持按照 name、instanceId、type 进行过滤
- 支持按照应用的创建时间排序
- 支持分页参数
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| opensearch:ListAppGroup | list |
|
| 无 |
请求语法
GET /v4/openapi/app-groups HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| pageNumber | integer | 否 | 页码，默认 pageNumber=1 | 1 |
| pageSize | integer | 否 | 每页返回数目，默认 pageSize=10 | 10 |
| instanceId | string | 否 | 实例 ID（精确匹配） | ops-cn-xxxx |
| name | string | 否 | 应用名称 | my_name |
| type | string | 否 | 应用类型
| standard |
| sortBy | integer | 否 | 排列顺序
默认 sortBy=0 | 0 |
| resourceGroupId | string | 否 | 资源 id | "110123123" |
| tags | array<object> | 否 | 标签列表 | |
| object | 否 | |||
| key | string | 否 | 标签键 | foo |
| value | string | 否 | 标签值 | 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": "ha3"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-16 | OpenAPI 返回结构发生变更 | 查看变更详情 |