実行詳細の取得

このAPIを使用して、バウンス実行の詳細を取得します。

API

/selfservice/v1/customers/{supportIdentifier}/{serviceType}/products/bounce/instances/{instanceId}/executions/{executionId}

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

依存関係

機能

  • このAPIを使用すると、バウンス実行の詳細を取得できます。
  • 説明が必要なレスポンス・フィールド:
    • operationは、起動、停止、バウンスなどの任意の操作です。
    • servicesは、All、Apps、Components、AllwithVMまたはAppswithVMのいずれかです。
    • blackOutDurationは、停止操作で設定されるブラックアウト期間です。
    • durationは、パッチの適用に必要な時間です。
    • bounceOptionsは、バウンスする必要があるコンポーネントを指定します。適用可能なバウンス・オプションは、インスタンスのバウンス・オプションを取得するAPIを使用してフェッチできます。
    • primaryContactは、チケットの作成時に使用される連絡先です。このパラメータは、カスタマ・サポートID (CSI)の有効な連絡先です。

動詞

GET

パラメータ

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

サンプル・レスポンス

{
  "id": "3-7JZXAMZ",
  "target": "DCMATI",
  "operation": "stop",
  "services": "all",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "blackOutDuration": {
    "unit": "hours",
    "value": 2
  },
  "summary": "Submit Bounce",
  "scheduledStart": "2020-08-26T8:53:51-07:00",
  "scheduledEnd": "2020-08-26T10:53:51-07:00",
  "scheduledBy": "<email ID>",
  "isLogs": true,
  "createdOn": "2020-08-25T6:51:41-07:00",
  "createdBy": "<email ID>",
  "updatedOn": "2020-08-25T6:51:41-07:00",
  "updatedBy": "<email ID>",
  "bounceOptions": {
    "options": [
      {
        "name": "CLEAR_APACHE_CACHE",
        "value": true
      }
    ],
    "hosts": [
      {
        "name": "vserv1282.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "CONCURRENT_MANAGER",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          },
          {
            "name": "WORKFLOW_MAILER",
            "value": true
          }
        ]
      },
      {
        "name": "vserv1283.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "CONCURRENT_MANAGER",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          },
          {
            "name": "WORKFLOW_MAILER",
            "value": true
          }
        ]
      }
    ]
  },
  "ticketingDetails": {
    "rfcNumber": "3-7JZXAMZ",
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan",
    "rfcType": "OCIEBS_Prod_SelfService",
    "rfcSubType": "SelfService_Bounce",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "customerStatus": "Acknowledged"
  }
}