1 つのメンテナンスウィンドウを更新

項目一覧

必須のロール

リクエスト
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

終了日が将来の 1 つのメンテナンスウィンドウを更新します。

必須のロール

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

リクエスト

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

PATCH /groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}

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

名前	タイプ	説明
`PROJECT-ID`	string	プロジェクトの一意の識別子。
`MW-ID`	string	更新対象のメンテナンスウィンドウの一意の識別子です。

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。

false

envelope

ブール値

任意

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

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

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

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

false

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

リクエスト本文には、次のフィールドの少なくとも 1 つが含まれている必要があります。

Body Parameter	タイプ	必要性	説明
`alertTypeNames`	文字列の配列	必須	メンテナンスウィンドウ中にメッセージが表示されないようにします。たとえば: `HOST` 、 `REPLICA_SET` 、 `CLUSTER` 、 `AGENT` 、 `BACKUP`
`startDate`	string	必須	ISO8601 のタイムスタンプメンテナンスウィンドウが開始されたときに、 UTC で日付と時刻形式が表示されるようになりました。
`endDate`	string	必須	ISO8601 のタイムスタンプメンテナンスウィンドウが終了したときに UTC の日付と時刻形式で表示されるようになりました。
`description`	string	任意	メンテナンスウィンドウの説明。

応答

名前	タイプ	説明
`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	メンテナンスウィンドウの説明。このフィールドは、メンテナンスウィンドウの説明を指定した場合にのみ返されます。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}" \
6      --data '
7        {
8          "alertTypeNames" : [ "HOST", "REPLICA_SET" ]
9        }'

応答例

応答ヘッダー

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 201 Created
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" : [ "HOST", "REPLICA_SET" ],
3   "created" : "2015-10-22T20:49:35Z",
4   "description" : "my description",
5   "endDate" : "2015-10-23T23:30:00Z",
6   "groupId" : "{PROJECT-ID}",
7   "id" : "56294bdfd4c643eef5176b73",
8   "startDate" : "2015-10-23T22:00:00Z",
9   "updated" : "2015-10-22T20:49:35Z",
10   "links" : []
11 }

戻る

1 つのメンテナンスウィンドウを作成

1 つのメンテナンスウィンドウを削除

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}" \
6	--data '
7	{
8	"alertTypeNames" : [ "HOST", "REPLICA_SET" ]
9	}'

1	{
2	"alertTypeNames" : [ "HOST", "REPLICA_SET" ],
3	"created" : "2015-10-22T20:49:35Z",
4	"description" : "my description",
5	"endDate" : "2015-10-23T23:30:00Z",
6	"groupId" : "{PROJECT-ID}",
7	"id" : "56294bdfd4c643eef5176b73",
8	"startDate" : "2015-10-23T22:00:00Z",
9	"updated" : "2015-10-22T20:49:35Z",
10	"links" : []
11	}