Database Migration Service には、接続プロファイルと移行ジョブをプログラムで管理するための REST API が用意されています。REST API は、接続プロファイルと移行ジョブの作成と管理に関連するリソースによって定義されます。すべてのリソースとそのメソッドの詳細については、
Database Migration Service API リファレンスをご覧ください。
Database Migration Service REST API に直接リクエストを送信する場合は、正しい形式のリクエストを作成して、認証済みユーザーとしてリクエストを承認し、返されたレスポンスを処理する必要があります。このドキュメントのタスクの多くで、
cURL を使用した API の例が紹介されています。
API の使用例については、
Database Migration Service API リファレンスのリクエストのページをご覧ください。各ページには、複数のプログラミング言語で API を呼び出す例、正しい形式のリクエストの内容と、レスポンスで返されることが予想される内容を理解するのに役立つ、リクエスト固有の Explorer が含まれています。
インスタンスを管理する次のいずれかの方法を使用する場合も、Database Migration Service API を間接的に使用しています。
これらの方法、特にGoogle Cloud コンソールを使用するメリットは、接続プロファイルと移行ジョブを（ユースケースに応じて）非常に簡単に管理できることです。Database Migration Service をこれから使い始める場合は、REST API を直接操作する前に、まずはこれらのツールのいずれかから始めることをおすすめします。
API を有効にする
Database Migration Service API を使用するには、次の手順で有効にする必要があります。
Database Migration Service API を使用するには、必要な権限が必要です。権限には以下のようなものがあります。
Database Migration 管理者: この権限を持つユーザーは、接続プロファイルと移行ジョブの管理に使用される Database Migration Service のすべてのリソースにアクセスできます。
Database Migration 閲覧者: この権限を持つユーザーは、Database Migration Service の接続プロファイルと移行ジョブに読み取り専用でアクセスできます。
Cloud SQL 管理者: この権限を持つユーザーは、Database Migration Service で Cloud SQL の接続プロファイルと移行ジョブを作成、管理できます。
Google Cloud には Identity and Access Management（IAM）機能があり、特定の Google Cloud リソースに対するアクセス権を詳細に設定できるため、他のリソースへの不要なアクセスを防ぐことができます。 Google Cloud コンソール、API の IAM メソッド、Google Cloud CLI を使用して、Database Migration Service の権限を取得、設定できます。詳細については、
リソースへのアクセス権の付与、変更、取り消しをご覧ください。
ファイルから JSON データを指定する
cURL で API を使用する場合は、コマンドラインを使用してプロパティ値を指定します。パスワードやセキュリティ キーなどの機密性の高い値を扱う場合は、コマンドラインで指定するとセキュリティ上のリスクが生じます。セキュリティを強化するには、API 呼び出しの JSON データを含むファイルを作成し、コマンドラインでファイルのパスを指定します。
オブジェクトの作成など、一部の API 呼び出しは完了するまでに時間がかかる場合があります。API は非同期であるため、オペレーションがまだ進行中の場合でも、呼び出しはすぐに返されます。後続の API 呼び出しで新しく作成されたオブジェクトを使用する場合は、最初のオペレーションが完了するまで待ってから続行する必要があります。
Database Migration Service API を使用して
オペレーションを管理できます。収集します。
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["わかりにくい","hardToUnderstand","thumb-down"],["情報またはサンプルコードが不正確","incorrectInformationOrSampleCode","thumb-down"],["必要な情報 / サンプルがない","missingTheInformationSamplesINeed","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2025-08-18 UTC。"],[[["\u003cp\u003eThe Database Migration Service provides a REST API for managing connection profiles and migration jobs programmatically, with detailed resources and methods available in the API Reference.\u003c/p\u003e\n"],["\u003cp\u003eUsers can interact with the API directly using tools like cURL, requiring proper request formatting, user authentication, and response handling, or indirectly via the Google Cloud CLI and Google Cloud Console, which simplify these processes.\u003c/p\u003e\n"],["\u003cp\u003eTo utilize the API, it must be enabled in the Google Cloud project, either through the Google Cloud console or via the gcloud CLI, and the user must possess appropriate permissions, such as Database Migration Admin, Viewer, or Cloud SQL Admin.\u003c/p\u003e\n"],["\u003cp\u003eFor security, sensitive data for API calls can be stored in a file and referenced in cURL commands, instead of being directly entered in the command line.\u003c/p\u003e\n"],["\u003cp\u003eThe API handles long-running operations asynchronously, allowing users to manage operations via the API, such as showing details, listing, or deleting them.\u003c/p\u003e\n"]]],[],null,["# Use the Database Migration Service API\n\nDatabase Migration Service provides a REST API for administering your connection profiles and migration jobs programmatically. The REST API is defined by resources associated with creating and managing connection profiles and migration jobs. For details about all resources\nand their methods, see the\n[Database Migration Service API Reference](/database-migration/docs/reference/rest).\n\nWhen you send requests directly to the Database Migration Service REST API, you must create the\ncorrect form of the request, authorize the request as an authenticated user, and\nprocess any responses returned. Many of the tasks in this documentation provide\nAPI examples using [cURL](http://curl.haxx.se).\n\nFor more examples of using the APIs, see the page for the request in the\n[Database Migration Service API Reference](/database-migration/docs/reference/rest). Each page has\nexamples calling the API in several programming languages, as well as a\nrequest-specific Explorer to help you see what goes into a well-formed request\nand what to expect in the response.\n\nYou're also using the Database Migration Service API, indirectly, when you use any of the\nfollowing ways of administering instances:\n\n- [Google Cloud CLI](/sdk): A command-line interface (CLI) that you can use to work with your instances.\n\n- [Google Cloud console](https://console.cloud.google.com/): A graphical web interface.\n\nThe advantage of using these methods, especially the\nGoogle Cloud console, is that they can greatly simplify administering your\nconnection profiles and migration jobs (depending on your use case). If you're just starting out with\nDatabase Migration Service, then we recommend that you start with one of these tools first\nbefore working with the REST API directly.\n\nEnable the API\n--------------\n\nTo use the Database Migration Service API, you need to enable it: \n\n### Console\n\n1. [Enable the Database Migration Service API](https://console.cloud.google.com/apis/library/datamigration.googleapis.com).\n2. Select your project.\n3. Select **Continue**.\n\n### gcloud\n\n1. Enter the following to display the project IDs for your Google Cloud projects: \n\n ```bash\n gcloud projects list\n ```\n2. Set your default project: \n\n ```bash\n gcloud config set project YOUR_PROJECT_ID\n ```\n3. Enable the Cloud SQL Admin API: \n\n ```bash\n gcloud services enable datamigration.googleapis.com\n ```\n\nPermissions\n-----------\n\nYou must have the required permissions to use the Database Migration Service API. These permissions include:\n\n- Database Migration Admin: With this permission, a user gains access to all resources of Database Migration Service used to manage connection profiles and migration jobs.\n- Database Migration Viewer: With this permission, a user has read-only access to connection profiles and migration jobs in Database Migration Service.\n- Cloud SQL Admin: With this permission, a user can create and manage connection profiles and migration jobs for Cloud SQL in Database Migration Service.\n\nGoogle Cloud offers Identity and Access Management (IAM), which lets you give more granular access to specific Google Cloud resources and prevents unwanted access to other resources. You can get and set permissions for Database Migration Service using the Google Cloud console, the IAM methods of the API, or the Google Cloud CLI. For more information, see\n[Granting, changing, and revoking access to resources](/iam/docs/granting-changing-revoking-access).\n\nProvide JSON data from a file\n-----------------------------\n\nWhen you use the API with cURL, you provide property values using the command\nline. If you're working with sensitive values such as passwords or security\nkeys, providing them on the command line poses a security risk. For increased\nsecurity, you can create a file containing the JSON data for the API call, and\nprovide the path to the file on the command line.\n\nTo provide JSON data to your cURL API call from a file:\n\n1. Create a file containing everything enclosed in single quotes for the\n `--data` field.\n\n Include the curly brackets, but don't include the single quotes.\n2. At the command line, provide the path to the file, preceded by the\n `@` character, as the `--data` parameter:\n\n ```bash\n --data @\u003cpath-to-file\u003e/\u003cfilename\u003e\n ```\n\n \u003cbr /\u003e\n\nWork with long-running API calls\n--------------------------------\n\nSome API calls, such as object creation, can take some time to complete. Because\nthe API is asynchronous, the call returns immediately, even if the operation is\nstill in progress. If a subsequent API call uses the newly created object, then you\nmust wait for the first operation to complete before proceeding.\n\nYou can use the Database Migration Service API to\n[manage operations](/sdk/gcloud/reference/database-migration/operations). This includes:\n\n- [Showing details about an operation](/sdk/gcloud/reference/database-migration/operations/describe)\n- [Listing operations for a region](/sdk/gcloud/reference/database-migration/operations/list)\n- [Deleting an operation](/sdk/gcloud/reference/database-migration/operations/delete)\n\nDatabase Migration Service and Google APIs Discovery Service\n------------------------------------------------------------\n\n[Google APIs Discovery Service](/discovery) is a service that you can use to discover Google APIs. For example, when you use the [Google APIs Explorer](/apis-explorer) tool, you're using the Discovery Service.\n\n\u003cbr /\u003e\n\nIn the Discovery Service, Database Migration Service is represented as \"datamigration\" (for example:\nhttps://**datamigration**.googleapis.com/$discovery/rest?version=v1)."]]
