Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
測定値とアラート
/
メンテナンスウィンドウ

すべてのメンテナンスWindowsを取得する

項目一覧

  • 必須のロール
  • リクエスト
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • results embeddedDocument
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

終了日が近づいているすべてのメンテナンスWindowsを取得します。

必須のロール

割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。

リクエスト

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/maintenanceWindows/

リクエスト パス パラメーター

名前
タイプ
説明
PROJECT-ID
string
プロジェクトの一意の識別子。

リクエスト クエリ パラメータ

名前
タイプ
必要性
説明
default
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明
状態
HTTPレスポンス コード
envelope
期待される応答本体
false

リクエスト ボディ パラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明
results
配列
配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
links
配列
配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。
totalCount
数値
結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

results embeddedDocument

各結果は 1 つのメンテナンスウィンドウです。

名前
タイプ
説明
id
string
メンテナンスウィンドウの一意の識別子です。
groupId
string
このメンテナンスウィンドウが適用されるプロジェクトの一意の識別子。
created
string
ISO8601 のタイムスタンプ メンテナンスウィンドウが作成されたときの UTC の日時形式。
updated
string
ISO8601 のタイムスタンプ メンテナンス ウィンドウが最後にアップデートされたときの UTC 形式の日時。
startDate
string
ISO8601 のタイムスタンプ メンテナンスウィンドウが開始されたときに、 UTC で日付と時刻形式が表示されるようになりました。
endDate
string
ISO8601 のタイムスタンプ メンテナンス ウィンドウが終了したときに UTC の日付と時刻形式で表示されるようになりました。
alertTypeNames
文字列の配列
メンテナンスウィンドウ中にメッセージが表示されないようにします。 たとえば: HOST 、 REPLICA_SET 、 CLUSTER 、 AGENT 、 BACKUP
description
string
メンテナンスウィンドウの説明。 このフィールドは、メンテナンスウィンドウの説明を指定した場合にのみ返されます。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows"

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

1{
2  "results" : [ {
3    "alertTypeNames" : [ "BACKUP" ],
4    "created" : "2015-10-22T15:04:31Z",
5    "description" : "new description",
6    "endDate" : "2015-10-23T23:30:00Z",
7    "groupId" : "{PROJECT-ID}",
8    "id" : "5628faffd4c606594adaa3b2",
9    "startDate" : "2015-10-23T22:00:00Z",
10    "updated" : "2015-10-22T15:04:31Z",
11    "links" : []
12  }, {
13    "alertTypeNames" : [ "AGENT", "BACKUP" ],
14    "created" : "2015-10-22T15:40:09Z",
15    "endDate" : "2015-10-23T23:30:00Z",
16    "groupId" : "{PROJECT-ID}",
17    "id" : "56290359d4c606594adaafe8",
18    "startDate" : "2015-10-23T22:00:00Z",
19    "updated" : "2015-10-22T15:40:09Z",
20    "links" : []
21  } ],
22  "links" : [],
23  "totalCount" : 2
24}

戻る

メンテナンスウィンドウ

次へ

1 つのメンテナンスウィンドウを取得