Oracle Cloud Infrastructureドキュメント

構成タイプ詳細の取得

このAPIを使用して、構成タイプの詳細を取得します。

API

/selfservice/v1/customers/services/{serviceType}/products/config/types/{type}

スコープおよび認可

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

ヘッダー

  • Authorization: Bearer <Token>

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

  • Identifier: <JWKS Identifier>

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

依存関係

ベース・パス

/selfservice/v1/

機能

このAPIは、構成に適用可能な詳細を公開します。

これには、許可されたアクティビティのリストおよびパラメータなどの対応する詳細が含まれます。

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

動詞

GET

パラメータ

名前 タイプ 説明 必須
serviceType パス・パラメータ サービス・タイプ はい
type パス・パラメータ 構成タイプ(トレースおよびデバッグなど) はい

サンプル・レスポンス

{
  "config": "Trace & Debug",
  "activities": [
    {
      "id": 1,
      "name": "FRD Enable/Disable",
      "uiType": "Toggle",
      "duration": {
        "unit": "hours",
        "value": 2
      },
      "serviceType": "Outage",
      "serviceMessage": "Any RFC Created for this Activity will perform a bounce.",
      "bounce": true,
      "active": true,
      "details": [
        {
          "type": "Enable",
          "scope": "Execution",
          "displayOnCreate": true,
          "parameters": [
            {
              "id": 1,
              "parameterId": 1,
              "parameterName": "UserName",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": true,
              "default": null,
              "active": true,
              "displayName": "UserName"
            },
            {
              "id": 21,
              "parameterId": 12,
              "parameterName": "Auto_Disable_Interval",
              "parameterType": "HEADER",
              "uiDataType": "LOV",
              "mandatory": true,
              "default": null,
              "active": true,
              "displayName": "Auto Disable Interval",
              "options": [
                {
                  "value": "3",
                  "label": "3 Hrs",
                  "active": true
                },
                {
                  "value": "4",
                  "label": "4 Hrs",
                  "active": true
                }
              ]
            }
          ]
        },
        {
          "type": "Disable",
          "scope": "Execution",
          "displayOnCreate": false,
          "parameters": [
            {
              "id": 5,
              "parameterId": 3,
              "parameterName": "OS_Process_Identifier",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": false,
              "default": null,
              "active": true,
              "displayName": "OS Process Identifier"
            },
            {
              "id": 21,
              "parameterId": 12,
              "parameterName": "Auto_Disable_Interval",
              "parameterType": "HEADER",
              "uiDataType": "LOV",
              "mandatory": true,
              "default": null,
              "active": true,
              "displayName": "Auto Disable Interval",
              "options": [
                {
                  "value": "3",
                  "label": "3 Hrs",
                  "active": true
                },
                {
                  "value": "4",
                  "label": "4 Hrs",
                  "active": true
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "id": 2,
      "name": "FND Enable/Disable",
      "uiType": "Toggle",
      "duration": {
        "unit": "hours",
        "value": 2
      },
      "serviceType": "Normal",
      "serviceMessage": null,
      "bounce": false,
      "active": true,
      "details": [
        {
          "type": "Enable",
          "scope": "Execution",
          "displayOnCreate": true,
          "parameters": [
            {
              "id": 1,
              "parameterId": 1,
              "parameterName": "Debug_log_Module",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": false,
              "default": "%",
              "active": true,
              "displayName": "Debug Log Module"
            }
          ]
        },
        {
          "type": "Update",
          "parentActivityType": "Enable"
          "scope": "PostExecution",
          "displayOnCreate": false,
          "parameters": [
            {
              "id": 29,
              "parameterId": 13,
              "parameterName": "Log_Transfer",
              "parameterType": "HEADER",
              "uiDataType": "CHECKBOX_COUNTER",
              "mandatory": true,
              "active": true,
              "displayName": "Log Transfer"
            },
            {
              "id": 16,
              "parameterId": 3,
              "parameterName": "OS_Process_Identifier",
              "parameterType": "DETAIL",
              "uiDataType": "TEXT",
              "mandatory": false,
              "default": false,
              "active": true,
              "displayName": "OS Process Identifier"
            }
          ]
        }
      ]
    }
  ]
}