バックアップゲートウェイ向け GetDBListFromAgent API リファレンス - DMS - Alibaba Cloud - Data Management

操作説明

CreateGetDBListFromAgentTask 操作を呼び出して非同期タスクを作成し、TaskId を取得します。次に、TaskId を GetDBListFromAgent 操作に渡して、物理バックアップからデータベースおよびテーブルデータを取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dbs:GetDBListFromAgent

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BackupGatewayId	integer	任意	バックアップゲートウェイの ID。 DescribeBackupGatewayList 操作を呼び出してこのパラメーターを取得できます。説明このパラメーターは必須です。	160***
SourceEndpointRegion	string	任意	バックアップゲートウェイのリージョン ID。	cn-hangzhou
TaskId	integer	任意	非同期タスクの ID。 CreateGetDBListFromAgentTask 操作を呼び出してこのパラメーターを取得できます。	123456
ClientToken	string	任意	リクエストのべき等性を確保し、重複送信を防止するために使用されるクライアントトークン。この値はクライアントによって生成され、異なるリクエスト間で一意である必要があります。値は最大 64 文字の ASCII 文字で、非 ASCII 文字を含めることはできません。	ETnLKlblzczshOTUbOCzxxxxxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
HttpStatusCode	integer	HTTP 状態コード。	400
RequestId	string	リクエスト ID。	EB4DFD5E-3618-498D-BE35-4DBEA0072122
ErrCode	string	エラーコード。	InvalidParameter
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrMessage	string	エラーメッセージ。	This backupPlan can't support this action
DbList	object
dbName	array	データベースリスト。
	string	データベースリスト。	TaskDB

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 400,
  "RequestId": "EB4DFD5E-3618-498D-BE35-4DBEA0072122",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "This backupPlan can't support this action",
  "DbList": {
    "dbName": [
      "TaskDB"
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Request.Forbidden	Have no Permissions

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。