移動先

• リクエスト
• レスポンス

レプリケーション・サーバーへの保護ポリシーの追加

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/zdlra/{raTargetId}/replicationServers/{repServerName}/protectionPolicies/{policyName}

リカバリ・アプライアンスのレプリケーション・サーバーに保護ポリシーを追加します。これにより、必要に応じて、ポリシー内の保護されたデータベースがダウンストリーム・リカバリ・アプライアンスに追加されます。

リクエスト

パス・パラメータ

• policyName(必須): string
  保護ポリシー名。
• raTargetId(必須): string
  リカバリ・アプライアンスのターゲットID。

  例:

  F76BBCCBD8A0D4719A8AA588375FA8BE

• repServerName(必須): string
  レプリケーション・サーバー名。

ヘッダー・パラメータ

• ORCL-EM-ZDLRATARGET-AUTHORIZATION:
  アップストリーム・リカバリ・アプライアンスの管理者資格証明。指定しない場合は、優先資格証明が使用されます。

  例:

  NAMED:NC_RA_UPSTREAM

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

レプリケーション・サーバーに追加する保護ポリシーを識別するパラメータ

ソースの表示

• protectionPolicies(必須): array protectionPolicies
  レプリケーション・サーバーに追加する保護ポリシーのリスト

{
    "type":"object",
    "description":"Parameter to identify the protection policies to be added to the Replication Server",
    "required":[
        "protectionPolicies"
    ],
    "properties":{
        "protectionPolicies":{
            "description":"List of protection policies to be added to the Replication Server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AddPolicyToReplicationServerDetails"
            }
        }
    }
}

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

型: array

レプリケーション・サーバーに追加する保護ポリシーのリスト

ソースの表示

• 配列: object AddPolicyToReplicationServerDetails
  レプリケーション・サーバーへの保護ポリシーの追加APIのパラメータ。

{
    "description":"List of protection policies to be added to the Replication Server",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AddPolicyToReplicationServerDetails"
    }
}

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

型: object

レプリケーション・サーバーへの保護ポリシーの追加APIのパラメータ。

ソースの表示

• downstreamPolicyGoal: string
  作成するダウンストリーム・ポリシーのリカバリ・ウィンドウ目標(useExistingDsPolicyがfalseの場合のみ)。値はISO 8601期間形式です。例 - P2D (2日)、PT3H (3時間)、PT78M (78分)、PT345S (345秒)

  例: P3D
• downstreamPolicyName: string
  データベースを追加する必要があるダウンストリーム保護ポリシーの名前(ダウンストリームで既存または作成するポリシーのいずれか)。

  例: GOLD_DOWNSTREAM
• downstreamRaCred: string
  ダウンストリーム・リカバリ・アプライアンスの管理者資格証明

  例: NAMED:NC_RA_DOWNSTREAM
• downstreamRaDbName(必須): string
  ダウンストリーム・リカバリ・アプライアンスのデータベース名。

  例: DB_DOWNSTREAM
• downstreamRaName(必須): string
  ダウンストリーム・リカバリ・アプライアンス名。

  例: RA_DOWNSTREAM
• downstreamRepServerName: string
  ダウンストリーム・リカバリ・アプライアンスのレプリケーション・サーバーの名前。値は、enableTwoWayReplicationがtrueの場合にのみ必要です。

  例: DB_DOWNSTREAM_UNIQUENAME_DB_UPSTREAM_UNIQUENAME_REP
• downstreamRepUser(必須): string
  レプリケートされたバックアップを管理する権限を付与される、ダウンストリーム・リカバリ・アプライアンスの一意の仮想プライベート・カタログ・ユーザーのデータベース・ユーザー名。このユーザーには、ダウンストリーム保護ポリシーに登録されている各保護されたデータベースへのアクセス権が付与されます。

  例: REPUSER_FROM_DB_UPSTREAM_UNIQUENAME_TO_DB_DOWNSTREAM_UNIQUENAME
• downstreamVpcUser: string
  バックアップおよびリカバリの目的で、ダウンストリーム・ポリシーの保護されたデータベースへのアクセス権を付与する必要がある追加のダウンストリームVPCユーザー。このユーザーは、レプリケーション・ユーザーとは異なります。

  例: BACKUPUSER1
• enableTwoWayReplication: boolean
  デフォルト値: false

  双方向レプリケーションを有効にする必要があるかどうかを示します。つまり、ダウンストリーム保護ポリシーは、アップストリーム・リカバリ・アプライアンスを指すダウンストリーム・レプリケーション・サーバーにも追加されます。
• mode: string
  指定可能な値: [ "REPLICATION", "READ-ONLY", "REQUEST-ONLY" ]

  保護ポリシーをレプリケーション・サーバーに追加するときに使用するモード。指定可能な値は、REPLICATION (デフォルト)、READ-ONLYおよびREQUEST-ONLYです。
• numDbsNeedingEnrollment: integer
  ダウンストリーム・リカバリ・アプライアンスに登録する必要があるデータベースの数。
• raDbType(必須): string
  指定可能な値: [ "rac_database", "oracle_database" ]

  リカバリ・アプライアンスのデータベース・タイプ(本番の場合はrac_database、ビュー・ベースのRAの場合はoracle_database)
• skipInitialReplication: boolean
  デフォルト値: false

  初期レプリケーションをスキップするかどうかを示します(デフォルトはfalse)。
• upstreamRaDbName(必須): string
  アップストリーム・リカバリ・アプライアンスのデータベース名。

  例: DB_UPSTREAM
• upstreamRepUser: string
  アップストリーム・ポリシーの保護されたデータベースへのアクセス権を付与する必要がある、アップストリーム・リカバリ・アプライアンスの一意の仮想プライベート・カタログ・ユーザーのデータベース・ユーザー名。enableTwoWayReplicationがtrueの場合にのみ必要です。

  例: REPUSER_FROM_DB_DOWNSTREAM_UNIQUENAME_TO_DB_UPSTREAM_UNIQUENAME
• useExistingDsPolicy(必須): boolean
  ダウンストリーム・リカバリ・アプライアンスに登録されていないアップストリーム保護ポリシーのデータベースを既存のダウンストリーム・ポリシーに追加する必要があるかどうかを示します。falseの場合、ダウンストリーム・リカバリ・アプライアンスに新しいポリシーが作成され、それらのデータベースが追加されます。

{
    "type":"object",
    "description":"Parameters for the Add Protection Policy to Replication Server API.",
    "required":[
        "downstreamRaName",
        "upstreamRaDbName",
        "downstreamRaDbName",
        "raDbType",
        "useExistingDsPolicy",
        "downstreamRepUser"
    ],
    "properties":{
        "downstreamRaName":{
            "type":"string",
            "description":"Downstream Recovery Appliance name.",
            "example":"RA_DOWNSTREAM"
        },
        "upstreamRaDbName":{
            "type":"string",
            "description":"Upstream Recovery Appliance database name.",
            "example":"DB_UPSTREAM"
        },
        "downstreamRaDbName":{
            "type":"string",
            "description":"Downstream Recovery Appliance database name.",
            "example":"DB_DOWNSTREAM"
        },
        "raDbType":{
            "$ref":"#/components/schemas/RaDbTypeEnum"
        },
        "numDbsNeedingEnrollment":{
            "type":"integer",
            "description":"Number of databases that need to be enrolled on downstream Recovery Appliance."
        },
        "useExistingDsPolicy":{
            "type":"boolean",
            "description":"Indicates if databases in the upstream protection policy that are not enrolled on the downstream Recovery Appliance should be added to an existing downstream policy. If false a new policy will be created on the downstream Recovery Appliance, and those databases will be added to it."
        },
        "downstreamPolicyName":{
            "type":"string",
            "description":"Name of downstream protection policy that databases should be added to (either an existing or to be created policy on the downstream).",
            "example":"GOLD_DOWNSTREAM"
        },
        "downstreamPolicyGoal":{
            "type":"string",
            "description":"Recovery Window Goal of the downstream policy to be created (only if useExistingDsPolicy is false). Value is in ISO 8601 duration format. Examples - P2D (2 days), PT3H (3 hours), PT78M (78 minutes), PT345S (345 seconds)",
            "example":"P3D"
        },
        "mode":{
            "$ref":"#/components/schemas/AddPolicyModeEnum"
        },
        "skipInitialReplication":{
            "type":"boolean",
            "default":false,
            "description":"Indicates if the initial replication is to be skipped (default is false)."
        },
        "enableTwoWayReplication":{
            "type":"boolean",
            "default":false,
            "description":"Indicates if two-way replication should be enabled, which means that the downstream protection policy will also be added to the downstream replication server which points to the upstream Recovery Appliance."
        },
        "downstreamRepServerName":{
            "type":"string",
            "description":"Replication Server name on downstream Recovery Appliance. Value is only needed if enableTwoWayReplication is true.",
            "example":"DB_DOWNSTREAM_UNIQUENAME_DB_UPSTREAM_UNIQUENAME_REP"
        },
        "downstreamRaCred":{
            "type":"string",
            "description":"Administrator credential for the downstream Recovery Appliance",
            "example":"NAMED:NC_RA_DOWNSTREAM"
        },
        "downstreamRepUser":{
            "type":"string",
            "description":"Database user name for a unique virtual private catalog user on the downstream Recovery Appliance to be granted permission to manage the replicated backups. This user will be granted access to each protected database enrolled with the downstream protection policy.",
            "example":"REPUSER_FROM_DB_UPSTREAM_UNIQUENAME_TO_DB_DOWNSTREAM_UNIQUENAME"
        },
        "downstreamVpcUser":{
            "type":"string",
            "description":"An additional downstream VPC user that should be granted access to the protected databases in the downstream policy for backup and recovery purposes. This user is not the same as the replication user.",
            "example":"BACKUPUSER1"
        },
        "upstreamRepUser":{
            "type":"string",
            "description":"Database user name for a unique virtual private catalog user on the upstream Recovery Appliance who should be granted access to the protected databases in the upstream policy. Only needed if enableTwoWayReplication is true.",
            "example":"REPUSER_FROM_DB_DOWNSTREAM_UNIQUENAME_TO_DB_UPSTREAM_UNIQUENAME"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

202レスポンス

許容

本文()

ルート・スキーマ: ReplicationServerDpSubmissionDetails

型: object

レプリケーション・デプロイメント・プロシージャ発行の詳細。

ソースの表示

• executionId(必須): string
  デプロイメント・プロシージャの実行ID。
• instanceName(必須): string
  デプロイメント・プロシージャ・インスタンス名。
• procedureId(必須): string
  デプロイメント・プロシージャの発行ID。
• submissionBy(必須): string
  デプロイメント・プロシージャを発行したEnterprise Managerユーザーの名前。
• submissionName(必須): string
  発行されたデプロイメント・プロシージャの名前。
• submittedDpEmUrl(必須): string
  Enterprise Managerデプロイメント・プロシージャの詳細ページへのリンク。

  例: /em/faces/core-jobs-procedureExecutionTracking?showProcActLink=yes&executionGUID=C0E2AD7B1E61060BE053B36FF10A1B07&instanceGUID=C0E2AD7B1E5C060BE053B36FF10A1B07

{
    "type":"object",
    "description":"Replication deployment procedure submission details.",
    "required":[
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId",
        "instanceName",
        "submittedDpEmUrl"
    ],
    "properties":{
        "submissionName":{
            "type":"string",
            "description":"Name of the submitted deployment procedure."
        },
        "submissionBy":{
            "type":"string",
            "description":"Name of the Enterprise Manager user who submitted the deployment procedure."
        },
        "executionId":{
            "type":"string",
            "description":"Deployment procedure execution id."
        },
        "procedureId":{
            "type":"string",
            "description":"Deployment procedure submission id."
        },
        "instanceName":{
            "type":"string",
            "description":"Deployment procedure instance name."
        },
        "submittedDpEmUrl":{
            "type":"string",
            "description":"Link to the Enterprise Manager deployment procedure details page.",
            "example":"/em/faces/core-jobs-procedureExecutionTracking?showProcActLink=yes&executionGUID=C0E2AD7B1E61060BE053B36FF10A1B07&instanceGUID=C0E2AD7B1E5C060BE053B36FF10A1B07"
        }
    }
}

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

本文()

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

• code(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る