Domainに設定された使用量制限を照会します。
- document_upload : アップロード’したDocumentサイズを表示します。 / uploaded documnet byte
- reindex : 再インデックス(セクション、インデックス追加時に発生)されたDocumentサイズを表示します。/ reindexed document byte
- autocomplete_reindex : 自動完成が適用されたDocumentの数を表示します。 / reindexed document count for autocomplete
- search_response : Search Queryネットワーク使用量を表示します。/ response size of searching, unit is byte
GET https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/{name}/quota
リクエスト
リクエストパラメー
| パラメータ名 |
必須 |
タイプ |
制約事項 |
説明 |
| name |
Yes |
string |
|
作成されているDomain名 |
レスポンス
| フィールド名 |
タイプ |
説明 |
備考 |
| [].type |
string |
使用量制限を設定した項目 |
search_response, document_upload, reindex, autocomplete_reindex |
| [].status |
string |
リソースステータス |
usable, unusable(使用量超過) |
| [].updateTime |
string |
最後に、ステータス或いは使用量制限設定が変更された時間 |
|
| [].quota |
number |
使用量制限 |
|
| [].interval |
string |
初期化周期 |
1Month, 1Day |
| [].usageQuantity |
number |
設定した周期の間の使用量 |
|
レスポンスStatus
| HTTP Status |
Desc |
| 200 |
OK(照会完了) |
| 400 |
Bad Request |
| 401 |
Unauthorized |
| 403 |
Forbidden |
| 404 |
Not Found |
| 500 |
Internal Server Error |
例示
リクエスト例示
GET /CloudSearch/beta/v1/domain/my_service/quota HTTP/1.1
Host: cloudsearch.apigw.ntruss.com
accept:application/json
x-ncp-iam-access-key: cPMl0CYGgRYvEa8sylCj
x-ncp-apigw-signature-v2: +Ln++MqcKHckKli2y/bB76xLUu8qR9rLvo6j2yIYuYg=
x-ncp-apigw-timestamp: 1551453306138
レスポンス例示タ
[
{
"type": "search_response",
"status": "usable",
"updateTime": "30-04-2019 15:00:01",
"quota": 10000000000,
"interval": "1Month",
"usageQuantity": 6221
},
{
"type": "document_upload",
"status": "usable",
"updateTime": "30-04-2019 15:00:05",
"quota": 1000000,
"interval": "1Month",
"usageQuantity": 17736
}
]