獲取OpenSearch應用列表。
介面說明
支援按照 name、instanceId、type 進行過濾
支援按照應用的建立時間排序
支援分頁參數。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
opensearch:ListAppGroup |
list |
*AppGroup
|
無 | 無 |
請求文法
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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
回應主體。 |
{} |
|
| totalCount |
integer |
總筆數。 |
1 |
| requestId |
string |
請求 ID。 |
0A6EB64B-B4C8-CF02-810F-E660812972FF |
| result |
object |
應用資訊。 參考： AppGroup |
{} |
| beaconAppCreated |
integer |
||
| chargeType |
string |
付費類型。
|
POSTPAY |
| chargingWay |
integer |
計費類型。
|
1 |
| commodityCode |
string |
商品 CODE。 |
opensearch |
| components |
array<object> |
||
|
object |
|||
| code |
string |
||
| value |
string |
||
| created |
integer |
建立時間戳記。 |
1575442875 |
| currentVersion |
string |
當前線上版本。 |
110116134 |
| description |
string |
應用描述。 |
"xxx" |
| domain |
string |
domain |
"" |
| domainName |
string |
||
| engineType |
string |
引擎類型。 |
ha3 |
| hasPendingQuotaReviewTask |
integer |
是否配額審批中。
|
0 |
| id |
string |
應用 ID。 |
110116134 |
| inDebt |
boolean |
||
| instanceId |
string |
執行個體 ID。 |
"xxx" |
| lockMode |
string |
鎖定狀態。
|
Unlock |
| name |
string |
應用名稱。 |
os_function_test_v1 |
| produced |
integer |
是否生產完成。
|
1 |
| quota |
object |
應用配額資訊。 參考： Quota |
{} |
| computeResource |
integer |
運算資源（單位：LCU）。 |
20 |
| docSize |
integer |
儲存容量（單位：GB）。 |
1 |
| spec |
string |
規格。
|
opensearch.share.common |
| resourceGroupId |
string |
||
| status |
string |
應用狀態。
|
normal |
| switchedTime |
integer |
線上版本切換時間戳記。 |
0 |
| tags |
array<object> |
應用標籤。 |
|
|
object |
標籤。 |
||
| key |
string |
標籤鍵。 |
foo |
| value |
string |
標籤值。 |
bar |
| type |
string |
應用類型
|
enhanced |
| updated |
integer |
更新時間戳記。 |
1578916076 |
| versions |
array |
||
|
string |
|||
| zoneId |
string |
||
| elasticLcu |
integer |
樣本
正常返回樣本
JSON格式
{
"totalCount": 1,
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": {
"beaconAppCreated": 0,
"chargeType": "POSTPAY",
"chargingWay": 1,
"commodityCode": "opensearch",
"components": [
{
"code": "",
"value": ""
}
],
"created": 1575442875,
"currentVersion": "110116134",
"description": "\"xxx\"",
"domain": "\"\"",
"domainName": "",
"engineType": "ha3",
"hasPendingQuotaReviewTask": 0,
"id": "110116134",
"inDebt": false,
"instanceId": "\"xxx\"",
"lockMode": "Unlock",
"name": "os_function_test_v1",
"produced": 1,
"quota": {
"computeResource": 20,
"docSize": 1,
"spec": "opensearch.share.common"
},
"resourceGroupId": "",
"status": "normal",
"switchedTime": 0,
"tags": [
{
"key": "foo",
"value": "bar"
}
],
"type": "enhanced",
"updated": 1578916076,
"versions": [
""
],
"zoneId": "",
"elasticLcu": 0
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。