AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
See how MongoDB 9.0 delivers up to 2x higher throughput.
MongoDB Branding Shape
Register now >
Docs Menu

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

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

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

ベース URL: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/maintenanceWindows/
名前
タイプ
説明

PROJECT-ID

string

プロジェクトの一意の識別子。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体を pretty-print形式で返すかどうかを示すフラグ。

false

envelope

ブール値

任意

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

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

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

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

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

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

名前
タイプ
説明

results

配列

配列には、results 埋め込みドキュメント セクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。

links

配列

配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL間の関係は、 Web リンク仕様 で説明されています。

totalCount

数値

結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

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

名前
タイプ
説明

id

string

メンテナンスウィンドウの一意の識別子です。

groupId

string

このメンテナンスウィンドウが適用されるプロジェクトの一意の識別子。

created

string

メンテナンスウィンドウが作成されたときの ISO の日付と時刻形式(UTC)のタイムスタンプ。8601

updated

string

メンテナンスウィンドウが最後に更新されたときの ISO の日付と時刻形式(UTC)のタイムスタンプ。8601

startDate

string

メンテナンスウィンドウが開始されたときの ISO の日付と時刻形式(UTC)のタイムスタンプ。8601

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://cloud.mongodb.com/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}