終了日が未来の 1 つのメンテナンスウィンドウを取得します。
必須のロール
割り当てられた任意のロールを使用して、このエンドポイントを正常に呼び出すことができます。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}
リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | プロジェクトの一意の識別子。 |
| string | 検索対象のメンテナンスウィンドウの一意の識別子。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | メンテナンスウィンドウの一意の識別子です。 |
| string | このメンテナンスウィンドウが適用されるプロジェクトの一意の識別子。 |
| string | メンテナンスウィンドウが作成されたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601 |
| string | メンテナンスウィンドウが最後に更新されたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601 |
| string | メンテナンスウィンドウが開始されたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601 |
| string | メンテナンスウィンドウが終了するときの ISO8601 の日付と時刻形式の UTC のタイムスタンプ。 |
| 文字列の配列 | メンテナンスウィンドウ中にメッセージが表示されないようにします。 たとえば: |
| 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/{MW-ID}"
応答例
応答ヘッダー
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
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 "alertTypeNames" : [ "AGENT", "BACKUP" ], 3 "created" : "2015-10-22T15:04:31Z", 4 "description" : "new description", 5 "endDate" : "2015-10-23T23:30:00Z", 6 "groupId" : "{PROJECT-ID}", 7 "id" : "5628faffd4c606594adaa3b2", 8 "startDate" : "2015-10-23T22:00:00Z", 9 "updated" : "2015-10-22T15:04:31Z", 10 "links" : [] 11 }