すべてのプロダクト
Search

このプロダクト

    Data Management:CreateGetDBListFromAgentTask

    ドキュメントセンター

    Data Management:CreateGetDBListFromAgentTask

    最終更新日:Jan 13, 2026

    バックアップゲートウェイを使用してデータベースリストを取得するタスクを作成します。

    操作説明

    この API 操作はタスク ID を返します。返されたタスク ID に基づいて 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:CreateGetDBListFromAgentTask

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupGatewayId

    integer

    任意

    バックアップゲートウェイの ID。 DescribeBackupPlanList 操作を呼び出して ID をクエリできます。

    説明

    このパラメーターは必須です。

    160813
    DatabaseType

    string

    任意

    データベースのタイプ。 有効な値：

    • MySQL

    • MSSQL

    • Oracle

    • MariaDB

    • PostgreSQL

    • DRDS

    • MongoDB

    • Redis

    MySQL
    SourceEndpointRegion

    string

    任意

    バックアップゲートウェイが存在するリージョン。

    cn-hangzhou
    SourceEndpointIP

    string

    任意

    データベースへのアクセスに使用される URL。

    123.0.XX.XX
    SourceEndpointPort

    integer

    任意

    データベースへの接続に使用されるポート。

    3306
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

    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
    TaskId

    integer

    非同期タスクの ID。

    123456

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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