获取OpenSearch应用列表。
接口说明
- 支持按照 name、instanceId、type 进行过滤
- 支持按照应用的创建时间排序
- 支持分页参数
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /v4/openapi/app-groups
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | object [] | 否 | 标签列表 | |
key | string | 否 | 标签键 | foo |
value | string | 否 | 标签值 | bar |
返回参数
示例
正常返回示例
JSON
格式
{
"totalCount": 1,
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": [
{
"created": 1575442875,
"currentVersion": "110116134",
"pendingSecondRankAlgoDeploymentId": 0,
"lockMode": "Unlock",
"updated": 1578916076,
"id": "110116134",
"chargeType": "POSTPAY",
"hasPendingQuotaReviewTask": 0,
"secondRankAlgoDeploymentId": 0,
"name": "os_function_test_v1",
"instanceId": "\"xxx\"",
"processingOrderId": "\"xxx\"",
"chargingWay": 1,
"type": "enhanced",
"status": "normal",
"projectId": "\"xxx\"",
"switchedTime": 0,
"commodityCode": "opensearch",
"expireOn": "\"xxx\"",
"domain": "\"\"",
"description": "\"xxx\"",
"firstRankAlgoDeploymentId": 0,
"produced": 1,
"lockedByExpiration": 0,
"quota": {
"spec": "opensearch.share.common",
"docSize": 1,
"computeResource": 20
},
"tags": [
{
"key": "foo",
"value": "bar"
}
]
}
]
}
错误码
访问错误中心查看更多错误码。