CEMLI実行API仕様

CEMLI実行APIを使用して、(CEMLIが有効なのサポートIDの)該当するすべてのインスタンスのCEMLIパッチ実行を作成、スケジュール、取得、リストします。また、実行の競合をチェックし、実行ログを表示する機能も提供されます。

実行の作成

このAPIを使用して、CEMLI実行を作成します。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:API:PrivilegedUserスコープが必要です。
  • 顧客インスタンスについてのみCEMLI実行を作成できます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

依存関係

ベース・パス

/cemli/v1/

機能

  • このAPIを使用すると、ユーザーは顧客インスタンスのCEMLIパッチ実行を作成できます。
  • 説明が必要なリクエスト・フィールド:
    • selfServiceは、パッチ実行のタイプです。サポートされている値はCEMLI_PATCHです。
    • autoSkip値は、選択したパッチの適用中に障害が発生した場合に、後続のパッチの実行を継続する必要があるかどうかを決定します。
    • autoStop値は、選択したパッチの適用中に障害が発生した場合に実行を停止する必要があるかどうかを決定します。
    • nonProdRfcは、同じパッチ・リストでパッチ実行が実行された対応するNonProductionチケットです。
    • durationは、パッチの適用に必要な時間です。
    • bounceOptionsは、バウンスする必要があるコンポーネントを指定します。適用可能なバウンス・オプションは、インスタンスのバウンス・オプションの取得を使用してフェッチできます。
    • primaryContactは、チケットの作成時に使用される連絡先です。このパラメータは、カスタマ・サポートID (CSI)の有効な連絡先である必要があります。
  • 説明が必要なレスポンス・フィールド:
    • idは、実行の一意の識別子です。

動詞

POST

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ インスタンス名またはターゲット名 はい

サンプル・リクエスト

{
  "selfService": "CEMLI_PATCH",
  "patchNumbers": [
    10000001992,
    10000001991
  ],
  "summary": "Apply 2 cemli patches",
  "nonProdRfc": "3-B3RSD2H",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "bounceOptions": {
    "options": [
      {
        "name": "bounceAddOnCACHE",
        "value": true
      }
    ],
    "hosts": [
      {
        "name": "vserv1282.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          }
        ]
      },
      {
        "name": "vserv1283.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          }
        ]
      }
    ]
  },
  "autoSkip": true,
  "autoStop": false,
  "ticketingDetails": {
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan"
  }
}

サンプル・レスポンス

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ"
}

実行のスケジュール

このAPIを使用して、CEMLI実行をスケジュールまたは再スケジュールします。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions/{executionId}

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Approverスコープが必要です。
  • 顧客インスタンスについてのみCEMLI実行をスケジュールできます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

  • このAPIを使用すると、顧客インスタンスのCEMLIパッチ実行をスケジュールまたは再スケジュールできます。
  • 説明が必要なリクエスト・フィールド:
    • scheduledTimeは、実行をスケジュールする必要があるUTCの時間です。ScheduleTimeは、現在時刻から少なくとも16分後にする必要があります。

動詞

PUT

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ パッチを適用する必要があるインスタンス名またはターゲット名 はい
executionId パス・パラメータ パッチ実行の一意の実行ID はい

サンプル・リクエスト

{
  "scheduledTime": "2020-08-26T8:53:51-07:00",
  "action": "schedule"
}

サンプル・レスポンス(成功)

{
  "scheduledStart": "2020-08-26T8:53:51-07:00",
  "scheduledEnd": "2020-08-26T10:53:51-07:00",
  "status": "Open",
  "subStatus": "Ready For Execution",
  "custStatus": "Review Update"
}

サンプル・レスポンス(競合)

次に、インスタンスに対して競合するチケットが存在し、スケジューリングを続行できない場合のレスポンスを示します。

{
  "conflicts": [
    {
      "rfcNumber": "3-7JZXAMZ",
      "rfcType": "CODE_PROMO",
      "rfcSubType": "CEMLI_PATCH",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 2
      }
    },
    {
      "rfcNumber": "3-7JZXAGH",
      "rfcType": "OCIEBS_Prod_SelfService",
      "rfcSubType": "SelfService_Bounce",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 3
      }
    },
    {
      "rfcNumber": "3-6JZXAMH",
      "rfcType": "Configuration - EBSO",
      "rfcSubType": "Autoexec-Config",
      "status": "Open",
      "subStatus": "Ready For Scheduling/Approval",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 4
      }
    }
  ]
}

スケジュールの取消

このAPIを使用して、CEMLI実行のスケジュールを取り消します。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions/{executionId}

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Approverスコープが必要です。
  • 顧客インスタンスについてのみCEMLI実行を取り消すことができます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

  • このAPIを使用すると、CEMLIパッチ実行のスケジュールを取り消すことができます。

動詞

PUT

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ パッチを適用する必要があるインスタンス名またはターゲット名 はい
executionId パス・パラメータ パッチ実行の一意の実行ID はい

サンプル・リクエスト

{
  "action": "cancel"
}

サンプル・レスポンス(成功)

{
  "status": "Open",
  "subStatus": "Ready For Scheduling/Approval",
  "custStatus": "Review Update"
}

実行詳細の取得

このAPIを使用して、CEMLIパッチ実行の詳細を取得します。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions/{executionId}

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客の実行の詳細を取得できます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

  • このAPIを使用すると、CEMLIパッチ実行の詳細を取得できます。
  • 説明が必要なレスポンス・フィールド:
    • selfServiceは、パッチ実行のタイプです。サポートされている値はCEMLI_PATCHです。
    • autoSkip値は、選択したパッチの適用中に障害が発生した場合に、後続のパッチの実行を継続する必要があるかどうかを決定します。
    • autoStop値は、選択したパッチの適用中に障害が発生した場合に実行を停止する必要があるかどうかを決定します。
    • nonProdRfcは、同じパッチ・リストでパッチ実行が実行された対応するNonProductionチケットです。
    • durationは、パッチの適用に必要な時間です
    • bounceOptionsは、必要に応じてバウンスする必要があるコンポーネントを指定します。適用可能なバウンス・オプションは、インスタンスのバウンス・オプションの取得を使用してフェッチできます。
    • primaryContactは、チケットの作成時に使用される連絡先です。このパラメータは、カスタマ・サポートID (CSI)の有効な連絡先である必要があります。

動詞

GET

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ パッチを適用する必要があるインスタンス名またはターゲット名 はい
executionId パス・パラメータ パッチ実行の一意の実行ID はい

サンプル・レスポンス

{
  "autoSkip": true,
  "autoStop": false,
  "bounceOptions": {
    "hosts": [
      {
        "name": "adc42setest043.oracleoutsourcing.com",
        "options": [
          {
            "label": "Apache",
            "name": "APACHE",
            "value": true
          },
          {
            "label": "Concurrent Manager",
            "name": "CONCURRENT_MANAGER",
            "value": false
          }
        ],
        "tier": "MT"
      }
    ],
    "options": [
      {
        "label": "Managed Server",
        "name": "managed_servers",
        "value": false
      },
      {
        "label": "Clear Apache Cache",
        "name": "bounceAddOnCACHE",
        "value": true
      }
    ],
    "specialInstructionsExist": false
  },
  "createdBy": "<email ID>",
  "createdOn": "2021-12-21T14:34:39Z",
  "duration": {
    "unit": "Hours",
    "value": 2
  },
  "hotBackup": false,
  "id": "3-CDNJILA",
  "patchListOption": "10000001923-CEMLI#US",
  "patchNumbers": [
    "10000001923"
  ],
  "patchStaged": false,
  "scheduledBy": "<user's email ID>",
  "scheduledEnd": "2021-12-21T17:04:43Z",
  "scheduledStart": "2021-12-21T15:04:43Z",
  "summary": "Apply 1 cemli patches; Auto RFC - AutoSkip",
  "target": "TCMATI",
  "ticketingDetails": {
    "customerNote": "Action Plan",
    "customerStatus": "Review Update",
    "primaryContact": "<primary contact's email ID>",
    "rfcNumber": "3-CDNJILA",
    "rfcSubType": "CEMLI_PATCH",
    "rfcType": "OCIEBS_CEMLI_PATCH",
    "status": "Open",
    "subStatus": "Ready For Execution"
  },
  "updatedBy": "<user's email ID>",
  "updatedOn": "2021-12-21T14:34:44Z"
}

実行のリスト

このAPIを使用して、CEMLIパッチ実行をリストします。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/executions

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客に属する実行をリストできます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

  • このAPIを使用すると、CEMLIパッチ実行をリストできます。
  • 説明が必要なレスポンス・フィールド:
    • idは、チケットの一意の識別子です。

動詞

GET

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
target 問合せパラメータ インスタンス名またはターゲット名 いいえ
patchNumber 問合せパラメータ パッチ番号 いいえ
status 問合せパラメータ ステータス いいえ
subStatus 問合せパラメータ サブ・ステータス いいえ
customerStatus 問合せパラメータ 顧客ステータス いいえ

サンプル・レスポンス(成功)

[
  {
    "createdBy": "<email ID>",
    "createdOn": "2021-12-21T14:34:39Z",
    "id": "3-CDNJILA",
    "patchNumbers": [
      "10000001923"
    ],
    "scheduledBy": "<user's email ID>",
    "scheduledEnd": "2021-12-21T17:04:43Z",
    "scheduledStart": "2021-12-21T15:04:43Z",
    "target": "TCMATI",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Review Update",
      "primaryContact": "<Primary contact's email ID>",
      "rfcNumber": "3-CDNJILA",
      "rfcSubType": "CEMLI_PATCH",
      "rfcType": "OCIEBS_CEMLI_PATCH",
      "status": "Open",
      "subStatus": "Ready For Execution"
    }
  },
  {
    "createdBy": "<user's email ID>",
    "createdOn": "2021-12-21T14:28:30Z",
    "id": "3-CDN0AVI",
    "patchNumbers": [
      "10000001923"
    ],
    "target": "TCMATI",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Review Update",
      "primaryContact": "<Primary contact's email ID>",
      "rfcNumber": "3-CDN0AVI",
      "rfcSubType": "CEMLI_PATCH",
      "rfcType": "OCIEBS_CEMLI_PATCH",
      "status": "Open",
      "subStatus": "Ready for Scheduling/Approval"
    }
  }
]

実行の競合の取得

このAPIを使用して、実行の競合を取得します。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Approverスコープが必要です。
  • 顧客インスタンスに属する実行の競合の詳細を取得できます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

このAPIを使用すると、実行の競合を取得できます。

動詞

GET

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ インスタンス名またはターゲット名 はい
scheduledStart 問合せパラメータ スケジュールされた開始(競合チェックの開始日) いいえ
scheduledEnd 問合せパラメータ スケジュールされた終了(競合チェックの終了日) いいえ

サンプル・レスポンス

[
  {
    "rfcNumber": "3-7JZXAMZ",
    "rfcType": "CODE_PROMO",
    "rfcSubType": "CEMLI_PATCH",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "duration": {
      "unit": "hours",
      "value": 2
    }
  },
  {
    "rfcNumber": "3-7JZXAGH",
    "rfcType": "OCIEBS_Prod_SelfService",
    "rfcSubType": "SelfService_Bounce",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "duration": {
      "unit": "hours",
      "value": 3
    }
  },
  {
    "rfcNumber": "3-6JZXAMH",
    "rfcType": "Configuration - EBSO",
    "rfcSubType": "Autoexec-Config",
    "status": "Open",
    "subStatus": "Ready For Scheduling/Approval",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "duration": {
      "unit": "hours",
      "value": 4
    }
  }
]

実行のログ・ファイルのリスト

このAPIを使用して、CEMLIパッチ実行のログ・ファイルをリストします。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions/{executionId}/logs/

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客インスタンスに属するログ・ファイルをリストできます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

このAPIを使用すると、CEMLIパッチ実行のログ・ファイルをリストできます。

動詞

GET

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ インスタンス名またはターゲット名 はい
executionId パス・パラメータ パッチ実行の一意の実行ID はい

サンプル・レスポンス

[
  "3-7JZXAMZ_log1.zip","3-7JZXAMZ_log2.zip","3-7JZXAMZ_log3.log"
]

実行ログ詳細の取得

このAPIを使用して、実行ログを取得します。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions/{executionId}/logs/{logName}

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 割り当てられたサービスまたはインスタンスのログのみを表示できます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

  • このAPIを使用すると、実行ログを取得できます。コンテンツはbase64でエンコードされています。
  • 説明が必要なレスポンス・フィールド:
    • contentは、Base64でエンコードされたコンテンツです。

動詞

GET

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ インスタンス名またはターゲット名 はい
executionId パス・パラメータ 実行の一意の識別子 はい
logName パス・パラメータ ログ・ファイルのリストAPIを使用して取得されたログ・ファイルの名前 はい

サンプル・レスポンス

{
  "fileName": "3-7JZXAMZ_log1.zip",
  "content": "QUNFIHRlc3QgUGF0Y2g=120"
}

インスタンスのバウンス・オプションの取得

このAPIを使用して、インスタンスのバウンス・オプションを取得します。

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/options

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客インスタンスのバウンス・オプションを取得できます。
  • 顧客がCEMLI機能をオプトインしている場合のみ、CEMLI実行APIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/cemli/v1/

依存関係

機能

このAPIを使用すると、インスタンスのバウンス・オプションを取得できます。

動詞

GET

パラメータ

名前 タイプ 説明 必須
supportIdentifier パス・パラメータ カスタマ・サポートID (CSI) はい
serviceType パス・パラメータ サービス・タイプ(EBSO、EBSZ、EBSIなど) はい
instanceId パス・パラメータ インスタンス名またはターゲット名 はい

サンプル・レスポンス

{
  "hosts": [
    {
      "name": "adc42setest034.oracleoutsourcing.com",
      "options": [
        {
          "label": "OPMN services",
          "name": "OPMN",
          "value": false
        },
        {
          "label": "Apache",
          "name": "APACHE",
          "value": false
        },
        {
          "label": "Concurrent Manager",
          "name": "CONCURRENT_MANAGER",
          "value": false
        },
        {
          "label": "Workflow Mailer",
          "name": "WORKFLOW_MAILER",
          "value": false
        }
      ],
      "tier": "MT"
    }
  ],
  "options": [
    {
      "label": "Clear Apache Cache",
      "name": "bounceAddOnCACHE",
      "value": false
    }
  ],
  "specialInstructionsExist": false
}