OpenSearch アプリケーションのリストを照会します。
操作説明
名前、インスタンス ID、およびタイプでアプリケーションをフィルターします。
作成時間でアプリケーションをソートします。
ページングをサポートします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
opensearch:ListAppGroup |
list |
*AppGroup
|
なし | なし |
リクエスト構文
GET /v4/openapi/app-groups HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| pageNumber |
integer |
任意 |
ページ番号。デフォルト値: 1。 |
1 |
| pageSize |
integer |
任意 |
各ページで返されるエントリ数。デフォルト値: 10。 |
10 |
| instanceId |
string |
任意 |
インスタンスの ID。完全一致で照合されます。 |
ops-cn-xxxx |
| name |
string |
任意 |
アプリケーション名。 |
my_name |
| type |
string |
任意 |
アプリケーションのタイプ。有効な値:
|
standard |
| sortBy |
integer |
任意 |
ソート順。有効な値:
デフォルト値: 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 |
array<object> |
アプリケーション。 詳細については、「AppGroup」をご参照ください。 |
[] |
|
array<object> |
結果。 |
{} |
|
| created |
integer |
アプリケーションが作成された日時を示すタイムスタンプ。 |
1575442875 |
| currentVersion |
string |
現在のオンラインバージョンの ID。 |
110116134 |
| lockMode |
string |
ロックステータス。有効な値:
|
Unlock |
| updated |
integer |
アプリケーションが最後に更新された日時を示すタイムスタンプ。 |
1578916076 |
| id |
string |
アプリケーション ID。 |
110116134 |
| chargeType |
string |
課金方法。有効な値:
|
POSTPAY |
| hasPendingQuotaReviewTask |
integer |
クォータの承認ステータス。有効な値:
|
0 |
| name |
string |
アプリケーション名。 |
os_function_test_v1 |
| instanceId |
string |
インスタンス ID。 |
"xxx" |
| chargingWay |
integer |
課金方法。有効な値:
|
1 |
| type |
string |
アプリケーションのタイプ。有効な値:
|
enhanced |
| status |
string |
アプリケーションのステータス。有効な値:
|
normal |
| projectId |
string |
A/B テストプロジェクトの名前。 |
"xxx" |
| switchedTime |
integer |
現在のオンラインバージョンが公開された日時を示すタイムスタンプ。 |
0 |
| commodityCode |
string |
商品コード。 |
opensearch |
| expireOn |
string |
アプリケーションの有効期限が切れる時間。 |
"xxx" |
| domain |
string |
アプリケーショングループのドメイン。 |
"" |
| description |
string |
アプリケーションの説明。 |
"xxx" |
| produced |
integer |
アプリケーションが作成されたかどうかを示します。有効な値:
|
1 |
| lockedByExpiration |
integer |
インスタンスが有効期限切れ後に自動的にロックされるかどうかを示します。 |
0 |
| quota |
object |
アプリケーションのクォータ情報。 詳細については、「Quota」をご参照ください。 |
{} |
| spec |
string |
仕様。有効な値:
|
opensearch.share.common |
| docSize |
integer |
ストレージ容量 (GB)。 |
1 |
| computeResource |
integer |
論理計算ユニット (LCU) 単位の計算リソース。 |
20 |
| tags |
array<object> |
アプリケーションのタグ。 |
|
|
object |
タグ。 |
||
| key |
string |
タグキー。 |
foo |
| value |
string |
タグの値。 |
bar |
| engineType |
string |
エンジンタイプ。 |
ha3 |
例
成功レスポンス
JSONJSON
{
"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"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。