終了日が将来の 1 つのメンテナンスウィンドウを更新します。
必須のロール
割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}リクエスト パス パラメーター
名前 | タイプ | 説明 |
|---|---|---|
| string | プロジェクトの一意の識別子。 |
| string | 更新対象のメンテナンスウィンドウの一意の識別子です。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
リクエスト本文には、次のフィールドの少なくとも 1 つが含まれている必要があります。
Body Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
| 文字列の配列 | 必須 | メンテナンスウィンドウ中にメッセージが表示されないようにします。 たとえば: |
| string | 必須 | メンテナンスウィンドウが開始される UTC の日付と時刻形式( ISO )のタイムスタンプ。8601 |
| string | 必須 | メンテナンスウィンドウが終了する日時( UTC )のタイムスタンプ( ISO 形式)。8601 |
| string | 任意 | メンテナンスウィンドウの説明。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
| string | メンテナンスウィンドウの一意の識別子です。 |
| string | このメンテナンスウィンドウが適用されるプロジェクトの一意の識別子。 |
| string | メンテナンスウィンドウが作成されたときのISO 8601の日付と時刻形式(UTC)のタイムスタンプ。 |
| string | メンテナンスウィンドウが最後に更新されたときの ISO 8601 日付と時刻形式(UTC)のタイムスタンプ。 |
| string | メンテナンスウィンドウが開始される UTC の日付と時刻形式( ISO )のタイムスタンプ。8601 |
| string | メンテナンスウィンドウが終了する日時( UTC )のタイムスタンプ( ISO 形式)。8601 |
| 文字列の配列 | メンテナンスウィンドウ中にメッセージが表示されないようにします。 たとえば: |
| string | メンテナンスウィンドウの説明。このフィールドは、メンテナンスウィンドウの説明を提供した場合にのみ表示されます。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}" \ --data ' { "alertTypeNames" : [ "HOST", "REPLICA_SET" ] }'応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "alertTypeNames" : [ "HOST", "REPLICA_SET" ], "created" : "2015-10-22T20:49:35Z", "description" : "my description", "endDate" : "2015-10-23T23:30:00Z", "groupId" : "{PROJECT-ID}", "id" : "56294bdfd4c643eef5176b73", "startDate" : "2015-10-23T22:00:00Z", "updated" : "2015-10-22T20:49:35Z", "links" : []}