Docs Menu
Docs Home
/
MongoDB Atlas
/
プログラムによるアクセス
/
Atlas Administration API

新しいバージョン管理された Atlas Administration API への移行

項目一覧

  • バージョン管理された Atlas Administration API の概要
  • バージョン管理された Atlas Administration API ライフサイクル
  • 手順

Versioned Atlas Administration API（ここでは /v2と呼ばれています）の導入により、レガシー Atlas Administration API（ /v1と参照）から新しい Versioned Atlas Administration API（ /v2 ）。

バージョン管理された Atlas Administration API の概要

新しいバージョンの Atlas Administration API により、プログラムとして Atlas にアクセスする際の全体的なエクスペリエンスが大幅に向上します。 バージョン管理された Atlas Administration API は、API の変更に関する予測可能で一貫したエクスペリエンスを提供し、新機能や変更に対する可視性を向上させます。

バージョン管理された Atlas Administration API ライフサイクル

は、現在の安定バージョンのAPI エンドポイントにAtlas な変更が導入された場合、既存の エンドポイントの新しいリソースAPI バージョンを公開します。AtlasAtlas が新しいリソース バージョンを公開すると、Atlas は古いリソース バージョンを自動的に非推奨にします。 Atlas は、非推奨の 12 か月後、非推奨のリソース バージョンを自動的に削除します。 Atlas は、本番環境で使用する古いリソース バージョンを最大 12 か月間サポートし続けますが、 APIエンドポイントの新しいバージョンに移行する必要があります。 詳しくは、 バージョン管理スキーマ の例を参照してください。

リソースレベルのバージョン管理では、バージョン管理された Atlas Administration API 内の各リソースが、他のリソースとは独立して新しいバージョンを導入する可能性があることに注意してください。 利用しているリソースが非推奨の場合にのみ、 アクション を実行する必要があります。

例

Atlas が 2023 年 6 月 01 日に新しい/serverlessリソースを導入しているが、 /backupには重大な変更がなく、2023 年 02 月 01 日のままであるとします。 /serverlessリソースを利用している場合にのみ、2023 年 06 月 01 日に移行する必要があります。 /serverlessリソースを実装していない場合は、アクションを実行する必要はありません。

Atlas は、非推奨のリソース バージョンが削除されるまで少なくとも 12 か月間サポートするため、新しいバージョンへの計画と移行に時間を提供できます。 API Changelogでは新しいリソースごとの変更を、 API 仕様では API バージョンの詳細を確認できます。

手順

新しい バージョン管理された Atlas Administration API に移行するには、次の手順を実行する必要があります。

1

リソースのベースURLに Versioned APIを表す数値を指定します。

ベース URL
https://cloud.mongodb.com/api/atlas/<version-number>/

例

Atlas Administration API リソースのレガシー バージョンの次のベースURLについて考えてみましょう。

https://cloud.mongodb.com/api/atlas/v1.0/

Versioned Admin API を導入すると、上記のベースURLはバージョン管理されていないリソースを使用していることを示します。 Versioned Atlas Administration API（ /v2 ）リソースにリクエストを送信するには、次のベースURLにリクエストを送信する必要があります。

https://cloud.mongodb.com/api/atlas/v2/

さまざまな状態で Atlas Administration API エンドポイントにリクエストを送信する方法については、「バージョン管理スキーマ 」を参照してください。

2

リクエストにバージョン管理するAccept ヘッダーを追加します。

バージョン管理された Atlas Administration API を使用するには、リソースのリソース バージョンを提供する必要があります。 最初のバージョンはすべてのリソースで同じであるため、バージョン化されていないレガシー API からバージョン化された API への初期移行には、リソースのバージョン日付に対応するバージョン番号を使用する必要があります。

例

次の curl コマンドは、 ヘッダーを含むバージョン管理された Atlas Administration API（v2）エンドポイントに対するリクエストの例です。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/vnd.atlas.{yyyy-mm-dd}+json" \
  --request {GET|DELETE}
  "https://cloud.mongodb.com/api/atlas/v2/{RESOURCE}/{ENDPOINT}?{PARAMS}"

POST 、 PUT 、またはPATCHリクエストのコンテンツタイプも指定する必要があります。 コンテンツ タイプ の値は次のいずれかになります。

  • application/json

  • application/vnd.atlas.{yyyy-mm-dd}+json

例

次の curl コマンドは、 ヘッダーとコンテンツ タイプを伴うバージョン管理された Atlas Administration API（v2）エンドポイントに対するリクエストの例えです。

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Content-Type: application/vnd.atlas.{yyyy-mm-dd}+json" \
  --header "Accept: application/vnd.atlas.{yyyy-mm-dd}+json" \
  --request {POST|PUT|PATCH}
  "https://cloud.mongodb.com/api/atlas/v2/{RESOURCE}/{ENDPOINT}?{PARAMS}"

バージョン管理された Atlas Administration API ヘッダーの詳細については、「 バージョン管理スキーマ 」で「 API ライフサイクル 」を参照してください。

3

変更ログ を確認して、新しいリソース バージョンの Atlas Administration API エンドポイントの構文の変更を確定します。

APIエンドポイントの新しいリソース バージョンには重大な変更が含まれる可能性があります。 新しいリソースへのリクエストにこれらの変更が反映され、リクエスト ヘッダーにリクエストを送信するエンドポイントの状態が含まれていることを確認します。

注意

バージョン管理されていない Atlas Administration API からリソース バージョン2023 - 02 - 01へのバージョン化された Atlas Administration API への初期移行のAPI 変更ログを確認する必要はありません。ただし、 /v1.0/clustersリソースをバージョン管理された に移行する場合を除きます。 Atlas Administration API (v 2 ) /clustersリソース 2023-02-01上の バージョン管理された Atlas Administration API の初回リリースには、 /clustersリソースのみの構文の変更が含まれています。 詳しくは、 クラスターの API 仕様を参照してください。

4

（任意） バージョン管理されていない Atlas Administration API v1.0 クラスター リソースを バージョン化された Atlas Administration API（v2）クラスター リソースに移行します。

バージョン管理された Atlas Administration API の2023-02-01リリースには、クラスターリソースの次の構文の変更が含まれています。

バージョン管理された Atlas Administration API (v2) エンドポイント リクエスト タイプ
変更履歴
POST

次の変更が含まれます。

  • 次のリクエスト プロパティを削除します。

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • リクエスト プロパティを追加します replicationSpecs.regionConfigs

  • 応答から次の任意プロパティを削除します。

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • 応答プロパティを追加します replicationSpecs.regionConfigs

GET（すべて）

次の変更が含まれます。

  • 応答から次の任意プロパティを削除します。

    • results.items.mongoURIWithOptions

    • results.items.providerBackupEnabled

    • results.items.mongoURIUpdated

    • results.items.srvAddress

    • results.items.replicationSpec

    • results.items.mongoURI

    • results.items.numShards

    • results.items.autoScaling

    • results.items.providerSettings

    • results.items.replicationFactor

    • results.items.replicationSpecs.regionsConfig

  • 応答プロパティを追加します results.items.replicationSpecs.regionConfigs

GET（1）

次の変更が含まれます。

  • 応答から次の任意プロパティを削除します。

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • 応答プロパティを追加します results.items.replicationSpecs.regionConfigs

PATCH（1 つ）

次の変更が含まれます。

  • 応答から次の任意プロパティを削除します。

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • 応答プロパティを追加します results.items.replicationSpecs.regionConfigs

  • 応答から次の任意プロパティを削除します。

    • mongoURIWithOptions

    • providerBackupEnabled

    • mongoURIUpdated

    • srvAddress

    • replicationSpec

    • mongoURI

    • numShards

    • autoScaling

    • providerSettings

    • replicationFactor

    • replicationSpecs.regionsConfig

  • 応答プロパティを追加します replicationSpecs.regionConfigs

バージョン管理されていない Atlas Administration API /clustersリソースを使用して 1 つの を作成し、 1 つの を取得し、すべての を取得し、 1 つの を変更し、 1 つのクラスターを削除すると、 1 つのを作成し、 1 つの を取得し、すべての を取得し、 1つのエンドポイントを削除します。バージョン管理された Atlas Administration API（v 2 ）クラスターリソース。

まだ2023-02-01バージョンに移行しない場合は、手順のステップ 1 と 2 のみを実行して、 2023-01-01 APIバージョンを使用します。 2023-01-01は非推奨であることに注意してください。

戻る

Versioning Overview

次へ

APIのアップグレード