Oracle Cloud Infrastructureドキュメント

バウンス・メタデータAPI仕様

バウンス・メタデータAPIを使用して、起動/停止/バウンスなどのバウンス・リクエストを送信するために必要なすべての前提条件の依存関係情報を提供します。この情報には、バウンス操作、サービス、期間およびチケット・キューの詳細が含まれます。また、環境インスタンス・オプションに関する情報も提供されます。

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

許可されたバウンス操作の取得

このAPIを使用して、許可されたバウンス操作を取得します。

API

/selfservice/v1/customers/services/products/bounce/operations

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

機能

  • このAPIは、許可されたバウンス操作のリストを公開します。
  • name値はキーです。
  • labelは、表示に使用される説明です。

動詞

GET

サンプル・レスポンス

[
  {
    "name": "Bounce",
    "label": "Bounce"
  },
  {
    "name": "Start",
    "label": "Start"
  },
  {
    "name": "Stop",
    "label": "Stop"
  }
]

適用可能なバウンス・サービスのリストの取得

このAPIを使用して、バウンス操作中に影響を受ける環境のデフォルト・サービスのリストを取得します。

API

/selfservice/v1/customers/services/products/bounce/services

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

機能

  • このAPIは、適用可能なバウンス・サービスのリストを公開します。
  • name値はキーです。
  • labelは、表示に使用される説明です。

動詞

GET

サンプル・レスポンス

[
  {
    "name": "All",
    "label": "All (Apps and DB)"
  },
  {
    "name": "Apps",
    "label": "All Apps"
  },
  {
    "name": "Components",
    "label": "Apps Components"
  }
]

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

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

API

/selfservice/v1/customers/{custId}/products/bounce/instances/{instanceName}/services

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客に属するインスタンスについてのみこの情報にアクセスできます。
  • 顧客がバウンス機能をオプトインしている場合のみ、バウンス・メタデータAPIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

依存関係

機能

  • このAPIは、特定の顧客インスタンスのバウンス中に影響を受けたサービスのリストを公開します。
  • name値はキーです。
  • labelは、表示に使用される説明です。
  • {custId}および{instanceName}は、前述の依存関係から取得できます。

動詞

GET

パラメータ

名前 タイプ 説明 必須
custId パス・パラメータ 顧客識別子 はい
instanceName パス・パラメータ インスタンス名 はい

サンプル・レスポンス

[
  {
    "name": "All",
    "label": "All (Apps and DB)"
  },
  {
    "name": "Apps",
    "label": "All Apps"
  },
  {
    "name": "Components",
    "label": "Apps Components"
  },
  {
    "name": "AllwithVM",
    "label": "All (Apps & DB) with VM"
  },
  {
    "name": "AppswithVM",
    "label": "All Apps with VM"
  }
]

キュー情報の取得

このAPIを使用して、バウンス・チケットのキュー情報を取得します。

API

/selfservice/v1/customers/services/{serviceType}/products/bounce/instances/{instanceName}/ticket/queue

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客に属するインスタンスについてのみこの情報にアクセスできます。
  • 顧客がバウンス機能をオプトインしている場合のみ、バウンス・メタデータAPIを使用できます。

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

依存関係

機能

このAPIは、バウンス・チケットのキュー情報を取得します。

チケット作成の前提条件として使用されます。

{serviceType}および{instanceName}は、前述の依存関係から取得できます。

動詞

GET

パラメータ

名前 タイプ 説明 必須
serviceType パス・パラメータ サービス・タイプ はい
instanceName パス・パラメータ インスタンス名 はい
services 問合せパラメータ

サービス・オプション[All、Apps、Components、AllwithVM、AppswithVM]

 いいえ

サンプル・レスポンス

{
    "category": "Application - EBS OCI",
    "serviceCode": "EBSI",
    "subType": "SelfService_Bounce",
    "type": "OCIEBS_Prod_SelfService"
}

使用可能期間の取得

このAPIを使用して、バウンス・チケットの使用可能期間を取得します。

API

/selfservice/v1/customers/services/products/bounce/durations

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

ベース・パス

/selfservice/v1/

機能

  • このAPIは、許可されたバウンス操作のリストを公開します。
  • displayValueは、表示目的で使用される値です。
  • valueは、処理対象として考慮される値です。

動詞

GET

サンプル・レスポンス

[
  {
    "displayValue": "2 hours",
    "value": "PT2H"
  },
  {
    "displayValue": "2 hours 30 minutes",
    "value": "PT2H30M"
  },
  {
    "displayValue": "3 hours",
    "value": "PT3H"
  },
  {
    "displayValue": "4 hours",
    "value": "PT4H"
  },
  ...
]