Oracle Database REST API

データ・ポンプ・ジョブの作成

POST

/database/datapump/jobs/

指定されたパラメータを使用してデータ・ポンプ・ジョブを作成し、開始します。パラメータの詳細な説明は、Oracle Data Pumpのドキュメントを参照してください。クライアントは、このサービスを起動するにはSQL管理者ロールが必要です。

リクエスト

サポートされるメディア・タイプ

application/json

ルート・スキーマ: schema

タイプ: object

ソースの表示

datapump_dir(optional): string

デフォルト値: DATA_PUMP_DIR

使用するデータベース・ディレクトリを指定します。
file_name(optional): string

データ・ポンプ・インポートに使用するファイル名パターン。操作がIMPORTの場合は必須です。
filter(optional): string

エクスポート対象のデータベース・オブジェクトを識別するために適用されるフィルタです。これは、19.1実装から引き継がれたメタデータ・フィルタ・パラメータの単純なリストを利用するためのエクスポートです。
job_mode(optional): string

デフォルト値: SCHEMA

指定できる値: [ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ]

データ・ポンプのジョブ・モードを指定します。
name_expressions(optional): array name_expressions

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。EXPORTとIMPORTの両方に適用可能です。
operation: string

指定できる値: [ "EXPORT", "IMPORT" ]

データ・ポンプ・ジョブ操作を指定します。
remap_schemas(optional): array remap_schemas

インポート・ジョブの再マップ・スキーマ・パラメータの定義に使用されます。IMPORTにのみ適用可能です。
schema_expressions(optional): array schema_expressions

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。EXPORTとIMPORTの両方に適用可能です。
tablespace_expressions(optional): array tablespace_expressions

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。EXPORTとIMPORTの両方に適用可能です。
threads(optional): integer

ジョブに使用可能なワーカー・プロセスの最大数。このパラメータを設定して、ジョブに使用するリソースの量を調整します。

{
    "type":"object",
    "required":[
        "operation"
    ],
    "properties":{
        "operation":{
            "type":"string",
            "description":"Specify the Data Pump job operation.",
            "enum":[
                "EXPORT",
                "IMPORT"
            ]
        },
        "datapump_dir":{
            "type":"string",
            "description":"Specify the database directory to use.",
            "default":"DATA_PUMP_DIR"
        },
        "filter":{
            "type":"string",
            "description":"The filter to apply to identify database objects for export. This an export convenience for simple lists in metadata filter parameters, carried over from 19.1 implementation."
        },
        "job_mode":{
            "type":"string",
            "description":"Specify the Data Pump job mode.",
            "default":"SCHEMA",
            "enum":[
                "FULL",
                "SCHEMA",
                "TABLE",
                "TABLESPACE"
            ]
        },
        "file_name":{
            "type":"string",
            "description":"The file name pattern to use for Data Pump import. Required when operation is IMPORT."
        },
        "threads":{
            "type":"integer",
            "description":"The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job."
        },
        "remap_schemas":{
            "type":"array",
            "description":"Used to define Remap Schema parameters for an import job. Only applicable for IMPORT.",
            "items":{
                "type":"object",
                "required":[
                    "source",
                    "target"
                ],
                "properties":{
                    "source":{
                        "type":"string",
                        "description":"Source schema to remap from."
                    },
                    "target":{
                        "type":"string",
                        "description":"Target schema to remap to."
                    }
                }
            }
        },
        "name_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Name Expression filter."
                    }
                }
            }
        },
        "schema_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Schema Expression filter."
                    }
                }
            }
        },
        "tablespace_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Tablespace Expression filter."
                    }
                }
            }
        }
    }
}

ネストされたスキーマ : name_expressions

タイプ: array

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。EXPORTとIMPORTの両方に適用可能です。

ソースの表示

配列: オブジェクト items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Name Expression filter."
            }
        }
    }
}

ネストされたスキーマ : remap_schemas

タイプ: array

インポート・ジョブの再マップ・スキーマ・パラメータの定義に使用されます。IMPORTにのみ適用可能です。

ソースの表示

配列: オブジェクト items

{
    "type":"array",
    "description":"Used to define Remap Schema parameters for an import job. Only applicable for IMPORT.",
    "items":{
        "type":"object",
        "required":[
            "source",
            "target"
        ],
        "properties":{
            "source":{
                "type":"string",
                "description":"Source schema to remap from."
            },
            "target":{
                "type":"string",
                "description":"Target schema to remap to."
            }
        }
    }
}

ネストされたスキーマ : schema_expressions

タイプ: array

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。EXPORTとIMPORTの両方に適用可能です。

ソースの表示

配列: オブジェクト items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Schema Expression filter."
            }
        }
    }
}

ネストされたスキーマ : tablespace_expressions

タイプ: array

データ・ポンプ・ジョブのメタデータ・フィルタ・パラメータの定義に使用されます。EXPORTとIMPORTの両方に適用可能です。

ソースの表示

配列: オブジェクト items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Tablespace Expression filter."
            }
        }
    }
}

ネストされたスキーマ: items

タイプ: object

ソースの表示

expression: string

名前式のフィルタとして使用されるSQL句。

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Name Expression filter."
        }
    }
}

ネストされたスキーマ: items

タイプ: object

ソースの表示

source: string

再マップするソース・スキーマ。
target: string

再マップ先のターゲット・スキーマ。

{
    "type":"object",
    "required":[
        "source",
        "target"
    ],
    "properties":{
        "source":{
            "type":"string",
            "description":"Source schema to remap from."
        },
        "target":{
            "type":"string",
            "description":"Target schema to remap to."
        }
    }
}

ネストされたスキーマ: items

タイプ: object

ソースの表示

expression: string

スキーマ式のフィルタとして使用されるSQL句。

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Schema Expression filter."
        }
    }
}

ネストされたスキーマ: items

タイプ: object

ソースの表示

expression: string

表領域式のフィルタとして使用されるSQL句。

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Tablespace Expression filter."
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

201レスポンス

正常に作成されたデータ・ポンプ・ジョブの詳細。

ルート・スキーマ: DataPumpJobsItem

タイプ: object

このオブジェクトは、データベース内の指定されたデータ・ポンプ・ジョブを表します。

ソースの表示

attached_sessions(optional): integer

ジョブに接続されたセッションの数
datapump_sessions(optional): integer

ジョブに含まれているデータ・ポンプのセッションの数
degree(optional): integer

操作を実行しているワーカー・プロセス数
job_mode(optional): string

ジョブのモード
job_name(optional): string

ユーザーが指定したジョブの名前(またはサーバーによって生成されたデフォルト名)
links(optional): array links
operation(optional): string

ジョブのタイプ
owner_name(optional): string

ジョブを起動したユーザー
state(optional): string

現在のジョブの状態

{
    "type":"object",
    "description":"This object represents a specified Data Pump job in the database.",
    "properties":{
        "owner_name":{
            "type":"string",
            "description":"User that initiated the job."
        },
        "job_name":{
            "type":"string",
            "description":"User-supplied name for the job (or the default name generated by the server)."
        },
        "operation":{
            "type":"string",
            "description":"Type of job."
        },
        "job_mode":{
            "type":"string",
            "description":"Mode of job."
        },
        "state":{
            "type":"string",
            "description":"Current job state."
        },
        "degree":{
            "type":"integer",
            "description":"Number of worker processes performing the operation."
        },
        "attached_sessions":{
            "type":"integer",
            "description":"Number of sessions attached to the job."
        },
        "datapump_sessions":{
            "type":"integer",
            "description":"Number of Data Pump sessions participating in the job."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

href: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

先頭に戻る

例

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、Data Pumpジョブを作成する方法を示しています。リクエスト本文で指定されている操作に応じて、Data Pumpジョブはインポート・ジョブまたはエクスポート・ジョブにできます。

curl -i -X POST -u username:password 
-d @request_body.json 
-H "Content-Type:application/json" https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/

リクエスト本文の例

ノート:

前述のコマンドで使用されるURL構造https://rest_server_url/resource-pathには、次の要素があります。

rest_server_urlはOracle Rest Data Serverが実行されているRESTサーバーです
URLの残りの部分には、ORDSコンテキスト・ルート、データベース識別子、スキーマ識別子、使用するORDSデータベースAPIのバージョンおよびこの操作のパスが含まれます。

次に、HRスキーマをエクスポートするData Pumpリクエストを送信するためのリクエスト本文の例を示します。

{
  "operation": "EXPORT",
  "schema_expressions": [
    {
      "expression": "IN ( 'HR' )"
    }
  ]
}

次に、HRスキーマをインポートし、それをBLAKEスキーマにマップするData Pumpリクエストを発行するためのリクエスト本文の例を示します。

{
  "operation": "IMPORT",
  "job_mode": "FULL",
  "file_name": "EXPDAT%U2019-03-25-12_55_03.DMP",
  "remap_schemas": [
    {
      "source": "HR",
      "target": "BLAKE"
    }
  ]
}

レスポンス・ヘッダーの例

次の例に、レスポンス・ヘッダーを示します。Locationヘッダーは、ジョブのステータスの表示に使用できるURIを返します。

HTTP/1.1 201 Created
Content-Type: application/json
Content-Location: https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_EXPORT_20190906155736/
ETag: "vdgVbEWipm96TpCidc5nFeC3BHMZd7adx8m4liaYSTEb7IwPVRykFAld4YP4Yh/PBuJ2Kv3fywyTvJykxERaEw=="
Location: http://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_EXPORT_20190906155736/
Transfer-Encoding: chunked

レスポンス本文の例

次の例は、JSON形式で返される201のレスポンス本文を示しています。


{
    "job_name": "DATAPUMP_REST_EXPORT_20190906155736",
    "owner_name": "PDBADMIN",
    "operation": "EXPORT",
    "job_mode": "SCHEMA",
    "state": "EXECUTING",
    "degree": 1,
    "attached_sessions": 0,
    "datapump_sessions": 2,
    "job_state": "EXECUTING",
    "links": [
        {
            "rel": "collection",
            "href": "http://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/"
        },
        {
            "rel": "describedby",
            "href": "http://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/metadata-catalog/"
        },
        {
            "rel": "related",
            "href": "http://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_EXPORT_20190906155736/EXPDAT-2019-09-06-15_57_36.LOG"
        },
        {
            "rel": "self",
            "href": "http://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_EXPORT_20190906155736/"
        }
    ]
}

先頭に戻る