アプリメタデータの取得

項目一覧

アプリ ID の検索

Atlas プロジェクト ID の検索

Atlas Device Sync、Atlas Edge Server、Data API、HTTPS endpoints は非推奨です。詳細については、の廃止ページを参照してください。

アプリ ID の検索

すべてのアプリには一意の ID があります。 App ID を使用して、使用または変更するアプリを指定します。

プロジェクト ID は、App Services UI で、または管理 API または App Services CLI を使用してプログラムで見つけることができます。

Atlas UI でアプリを見つける

MongoDB Atlas UIにログインし、 App Servicesタブをクリックします。

アプリを見つけ、そのサマリーカードをクリックしてアプリを開きます。

アプリ ID のコピー

左側のナビゲーションメニューの上部にあるアプリ名の横にあるCopy App ID ] ボタンをクリックします。

注意

UI の左上にアプリ名が表示されます。 [コピー] ボタンをクリックすると、UI はアプリ名ではなくアプリ ID をクリップボードにコピーします。たとえば、UI には「exampleApp」という名前が表示されますが、ID は「exampleApp-wkgs」がコピーされます。

アプリ ID を見つけるには、 appservices apps listを実行し、コマンドによって返されたリストで目的のアプリを見つけます。

リスト内の各エントリには、アプリのプロジェクト ID と、必要な 2 つのアプリ ID 値が表示されます。

クライアントアプリIDは、アプリ名を含む一意のstringです。この値を使用して、データ API または Realm SDK を介してアプリに接続します。
内部 16 進_idObjectId stringである {0 値。管理 API エンドポイントの{appId}の代わりにこの値を使用します。

appservices apps list

Found 3 apps
  Client App ID                    Project ID                _id
  -------------------------------  ------------------------  ------------------------
  myapp-abcde                      5b2ef33692f119212341b213  64343a2b2107b2523e60fb59
  myapp-dev-uvxyz                  5b2ef33692f119212341b213  6526d3582b032aff90351070
  my-other-app-abcde               5b2ef33692f119212341b213  674c19acef214b9ad99a0bbe

アプリID を見つけるには、 List すべてのアプリAPI エンドポイントにリクエストを送信します。

エンドポイントは、Atlas プロジェクトに関連付けられているアプリのリストを返します。対象のアプリを見つけて、そのアプリ ID をコピーします。

必要なアプリ ID の値は 2 つあります。

内部ObjectId 16 進stringである _id 値。管理 API エンドポイントの{appId}の代わりにこの値を使用します。
アプリ名を含む一意のstringである client_app_id 。この値を使用して、Data API または Realm SDK を介してアプリに接続します。

curl https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps \
  --header 'Authorization: Bearer <access_token>'

[
  {
    "_id": "63ea9328dddad2523e60fb59",
    "client_app_id": "myapp-abcde",
    "group_id": "57879f6cc4b32dbe440bb8c5",
    "domain_id": "5886619e46124e4c42fb5dd8",
    "name": "myapp",
    "location": "US-VA",
    "deployment_model": "GLOBAL",
    "last_used": 1615153544,
    "last_modified": 0,
    "product": "standard",
    "environment": ""
  }
]

Tip

<access_token>と{groupId}を必ず独自の値に置き換えてください。

Atlas プロジェクト ID の検索

すべてのアプリは、単一の Atlas プロジェクトに関連付けられています。アプリを識別し、プログラム的に操作するには、プロジェクトの一意のプロジェクト ID 値（「グループ ID」とも呼ばれます）を使用します。

プロジェクト ID は、Atlas UI で見つけるか、Atlas Admin API または Atlas CLI を使用してプログラムで見つけることができます。

プロジェクト ID は、App Services Admin UI で確認できます。

Atlas 組織の選択

Atlas ダッシュボードの左上隅には、アクセスできる組織を含むドロップダウンメニューが表示されます。表示するプロジェクトを含む組織を選択します。

プロジェクトを見つける

組織内のプロジェクトのリストを表示するには、左側のナビゲーションメニューでProjectsをクリックします。リスト内のプロジェクトを見つけます。

プロジェクト ID のコピー

プロジェクトリストビューの右側にはActions列があります。省略記号（ ... Copy Project IDアイコンをクリックして [アクション] メニューを展開し、[] を選択します。

Atlas CLI のprojects listコマンドを使用して、アクセス可能なすべての Atlas プロジェクトを一覧表示できます。

コマンドは、JSON 形式でプロジェクトのリストを返します。リストでプロジェクトを見つけ、そのid値をコピーします。

Tip

App Services CLI では、アプリを一覧表示するときにプロジェクト ID が含まれます。既存のアプリのプロジェクト ID を検索するには、 appservices apps listを実行します。詳しくは、「アプリ ID の検索」を参照してください。

atlas projects list

{
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups?pageNum=1\u0026itemsPerPage=100"
    }
  ],
  "results": [
    {
      "id": "5d0171d479328f10cb4f3037",
      "orgId": "629e04e11633f764462ea109",
      "name": "MyProject",
      "clusterCount": 1,
      "created": "2019-06-23T05:08:35Z",
      "links": [
        {
          "rel": "self",
          "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5d0171d479328f10cb4f3037"
        }
      ]
    }
  ],
  "totalCount": 1
}

Atlas Admin API のList すべてのプロジェクトエンドポイントを使用して、アクセス権を持つ Atlas プロジェクトを一覧表示できます。

エンドポイントは JSON 形式でプロジェクトのリストを返します。リストでプロジェクトを見つけ、そのid値をコピーします。

curl https://cloud.mongodb.com/api/atlas/v1.0/groups \
  --digest -u <Atlas Public API Key>:<Atlas Private API Key>

{
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups?pageNum=1\u0026itemsPerPage=100"
    }
  ],
  "results": [
    {
      "id": "5d0171d479328f10cb4f3037",
      "orgId": "629e04e11633f764462ea109",
      "name": "MyProject",
      "clusterCount": 1,
      "created": "2019-06-23T05:08:35Z",
      "links": [
        {
          "rel": "self",
          "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5d0171d479328f10cb4f3037"
        }
      ]
    }
  ],
  "totalCount": 1
}

戻る

アプリの開発と配置

アプリの更新