Oracle Cloud Infrastructure-Dokumentation

Konfigurationstypdetails abrufen

Mit dieser API können Sie Konfigurationstypdetails abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können auf diese Informationen nur für den Servicetyp zugreifen, der zu Ihrem Kunden gehört.
  • Sie können die Konfigurationsmetadaten-API nur verwenden, wenn Ihr Kunde sich für die Konfigurationsfunktionalität angemeldet hat.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Abhängigkeit

Basispfad

/selfservice/v1/

Funktionalität

Diese API stellt anwendbare Details für eine Konfiguration bereit.

Sie enthält eine Liste der zulässigen Aktivitäten und der zugehörigen Details wie Parameter.

{serviceType} und {type} können aus der angegebenen Abhängigkeit abgerufen werden.

Verb

GET

Parameter

Name Typ Beschreibung Obligatorisch
serviceType Pfadparameter Servicetyp Ja
type Pfadparameter Konfigurationstyp (Beispiel: Trace und Debug) Ja

Beispielantwort

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}