Oracle Cloud Infrastructureドキュメント

バウンス実行API仕様

バウンス実行APIを使用して、(バウンスが有効なサポートIDの)該当するすべてのインスタンスのバウンス実行を作成、スケジュール、取得、リストします。また、実行の競合およびバウンス・オプションをチェックする機能も提供されます。

次のリソースがサポートされています:

実行の作成

このAPIを使用して、バウンス実行を作成します。

API

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

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:API:PrivilegedUserスコープが必要です。
  • 顧客インスタンスについてのみバウンス実行を作成できます。
  • 顧客がバウンス機能をオプトインしている場合のみ、バウンス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は、バウンスする必要があるコンポーネントを指定します。前述の依存関係を使用して、適用可能なバウンス・オプションをフェッチできます。
    • primaryContactは、チケットの作成時に使用される連絡先です。primaryContactは、カスタマ・サポートID (CSI)の有効な連絡先です
  • 説明が必要なレスポンス・フィールド:
    • idは、実行の一意の識別子です。

動詞

POST

パラメータ

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

サンプル・リクエスト 

{
  "operation": "stop",
  "services": "All",
  "summary": "Submit Bounce",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "blackOutDuration": {
    "unit": "hours",
    "value": 2
  },
  "bounceOptions": {
    "options": [
      {
        "name": "CLEAR_APACHE_CACHE",
        "value": true
      },
      {
        "name": "MANAGED_SERVER",
        "value": false
      }
    ],
    "hosts": [
      {
        "name": "vserv1282.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "CONCURRENT_MANAGER",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          },
          {
            "name": "CLEAR_APACHE_CACHE",
            "value": false
          },
          {
            "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": "CLEAR_APACHE_CACHE",
            "value": false
          },
          {
            "name": "WORKFLOW_MAILER",
            "value": true
          }
        ]
      }
    ]
  },
  "ticketingDetails": {
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan"
  }
}

サンプル・レスポンス

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

実行のスケジュール

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

API

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

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

依存関係

機能

このAPIを使用すると、顧客インスタンスのバウンス実行をスケジュールまたは再スケジュールできます。
  • 説明が必要なリクエスト・フィールド:
    • 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を使用して、バウンス実行のスケジュールを取り消します。

API

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

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

依存関係

機能

このAPIを使用すると、バウンス実行のスケジュールを取り消すことができます。

動詞

PUT

パラメータ

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

サンプル・リクエスト 

{
  "action": "cancel"
}

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

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

実行詳細の取得

この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"
  }
}

実行のリスト

このAPIを使用して、バウンス実行をリストします。

API

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

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

依存関係

機能

このAPIを使用すると、バウンス実行をリストできます。

動詞

GET

パラメータ

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

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

[
  {
    "createdBy": "<email ID>",
    "createdOn": "2022-01-13T06:32:56Z",
    "id": "3-CDQF5Z0",
    "scheduledBy": "<email ID>",
    "scheduledEnd": "2022-01-14T05:00:00Z",
    "scheduledStart": "2022-01-14T03:00:00Z",
     "target": "OMCEBSOR3",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Review Update",
      "primaryContact": "<email ID>",
      "rfcNumber": "3-CDQF5Z0",
      "rfcSubType": "SelfService_Bounce",
      "rfcType": "OCIEBS_Prod_SelfService",
      "status": "Open",
      "subStatus": "Ready For Execution"
    }
  },
  {
    "createdBy": "<email ID>",
    "createdOn": "2022-01-12T08:40:03Z",
    "id": "3-CDQEVUP",
    "target": "TCMATI",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Acknowledged",
      "primaryContact": "<email ID>",
      "rfcNumber": "3-CDQEVUP",
      "rfcSubType": "ACE_DATAFIX",
      "rfcType": "OCIEBS_ACE_DATAFIX",
      "status": "Open",
      "subStatus": "Ready for Scheduling/Approval"
    }
  },
  {
    "createdBy": "<email ID>",
    "createdOn": "2021-12-21T14:34:39Z",
    "id": "3-CDNJILA",
    "scheduledBy": "<email ID>",
    "scheduledEnd": "2021-12-21T17:04:43Z",
    "scheduledStart": "2021-12-21T15:04:43Z",
    "target": "TCMATI",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Review Update",
      "primaryContact": "<email ID>",
      "rfcNumber": "3-CDNJILA",
      "rfcSubType": "CEMLI_PATCH",
      "rfcType": "OCIEBS_CEMLI_PATCH",
      "status": "Open",
      "subStatus": "Ready For Execution"
    }
  }
]

実行の競合の取得

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

API

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

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/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を使用して、インスタンスのバウンス・オプションを取得します。

API

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

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/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"
    },
    {
      "name": "adc42setest034.oracleoutsourcing.com",
      "options": [
        {
          "label": "Database",
          "name": "DATABASE",
          "value": false
        },
        {
          "label": "Database Listener",
          "name": "DB_LISTENER",
          "value": false
        }
      ],
      "tier": "DB"
    }
  ],
  "options": [
    {
      "label": "Clear Apache Cache",
      "name": "bounceAddOnCACHE",
      "value": false
    }
  ],
  "specialInstructionsExist": false
}