実行の詳細の取得

このAPIを使用して、構成実行の詳細を取得します。

API

/selfservice/v1/customers/{supportIdentifier}/{serviceType}/products/config/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を使用すると、構成実行の詳細を取得できます。
  • 説明が必要なリクエスト・フィールド:
    • primaryContactは、チケットの作成時に使用される連絡先です。このパラメータは、カスタマ・サポートID (CSI)の有効な連絡先です。
  • 説明が必要なレスポンス・フィールド:
    • idは、実行の一意の識別子です。

動詞

GET

パラメータ

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

サンプル・レスポンス

{
  "id": "3-7JZXAMZ",
  "target": "DCMATI",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "summary": "Apply Config Changes",
  "scheduledStart": "2020-08-26T8:53:51-07:00",
  "scheduledEnd": "2020-08-26T10:53:51-07:00",
  "scheduledBy": "<email iD>",
  "referenceExecutionId": "3-B3RSD2H",
  "bounce":true,
  "createdOn": "2020-08-25T6:51:41-07:00",
  "createdBy": "<email ID>",
  "updatedOn": "2020-08-25T6:51:41-07:00",
  "updatedBy": "<email ID>",
  "config": {
    "type": "Trace & Debug",
    "activity": {
      "name": "FRD Enable/Disable",
      "type": "Enable",
      "parameters": [
        {
          "name": "UserName",
          "value": "oracle"
        },
        {
          "name": "Auto_Disable_Interval",
          "value": "2"
        }
      ]
    }
  },
  "ticketingDetails": {
    "rfcNumber": "3-7JZXAMZ",
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan",
    "rfcType": "Configuration - EBSO",
    "rfcSubType": "Autoexec-Config",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "customerStatus": "Acknowledged"
  },
  "downStreamExecutions": [
    {
      "id": "3-7JZXAHB",
      "scheduledStart": "2020-08-26T11:53:51-07:00",
      "scheduledEnd": "2020-08-26T11:58:51-07:00",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "custStatus": "Review Update",
      "config": {
        "type": "Trace & Debug",
        "activity": {
          "name": "FRD Enable/Disable",
          "type": "Disable"
        }
      },
      "ticketingDetails": {
        "rfcNumber": "3-7JZXAHB",
        "primaryContact": "<email ID>",
        "customerNote": "Action Plan",
        "rfcType": "Configuration - EBSO",
        "rfcSubType": "Autoexec-Config",
        "status": "Open",
        "subStatus": "Ready For Execution",
        "customerStatus": "Acknowledged"
      }
    }
  ]
}