Documentazione di Oracle Cloud Infrastructure

Specifiche API metadati mancato recapito

Utilizzare l'API dei metadati di mancato recapito per fornire tutte le informazioni sulla dipendenza dei prerequisiti necessarie per sottomettere una richiesta di mancato recapito, ad esempio Avvio/Interruzione/Mancato recapito. Queste informazioni includono operazioni di mancato recapito, servizi, durata e dettagli della coda di ticket. Inoltre, fornisce informazioni sulle opzioni delle istanze di ambiente.

Sono supportate le seguenti risorse:

Recupera operazioni di mancato recapito consentite

Utilizzare questa API per ottenere le operazioni di mancato recapito consentite.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile utilizzare l'API dei metadati di mancato recapito solo se il cliente ha optato per la funzionalità di mancato recapito.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

  • Questa API espone un elenco di operazioni di mancato recapito consentite.
  • Il valore name è la chiave.
  • label è una descrizione utilizzata per le visualizzazioni.

Verbo

GET

Risposta di esempio

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

Recupera elenco di servizi mancato recapito applicabili

Utilizzare questa interfaccia API per ottenere un elenco dei servizi predefiniti nell'ambiente interessato durante l'operazione di mancato recapito.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile utilizzare l'API dei metadati di mancato recapito solo se il cliente ha optato per la funzionalità di mancato recapito.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

  • Questa API espone un elenco di servizi di mancato recapito applicabili.
  • Il valore name è la chiave.
  • label è una descrizione utilizzata per le visualizzazioni.

Verbo

GET

Risposta di esempio

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

Recupera opzioni istanza

Utilizzare questa API per ottenere le opzioni dell'istanza.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile accedere a queste informazioni solo per le istanze che appartengono al cliente.
  • È possibile utilizzare l'API dei metadati di mancato recapito solo se il cliente ha optato per la funzionalità di mancato recapito.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Dipendenza

Funzionalità

  • Questa API espone un elenco di servizi interessati durante il mancato recapito per un'istanza cliente specifica.
  • Il valore name è la chiave.
  • label è una descrizione utilizzata per le visualizzazioni.
  • È possibile recuperare {custId} e {instanceName} dalla dipendenza indicata.

Verbo

GET

Parametri

Nome Digita descrizione; obbligatorio
custId Parametro percorso Identificativo cliente Sì
instanceName Parametro percorso Nome istanza Sì

Risposta di esempio

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

Ottieni informazioni coda

Utilizzare questa API per ottenere informazioni sulla coda per i ticket di mancato recapito.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile accedere a queste informazioni solo per le istanze che appartengono al cliente.
  • È possibile utilizzare l'API dei metadati di mancato recapito solo se il cliente ha optato per la funzionalità di mancato recapito.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Dipendenza

Funzionalità

Questa API recupera le informazioni sulla coda per i ticket di mancato recapito.

Da utilizzare come prerequisito per la creazione di ticket.

È possibile recuperare {serviceType} e {instanceName} dalla dipendenza indicata.

Verbo

GET

Parametri

Nome Digita descrizione; obbligatorio
serviceType Parametro percorso Tipo di servizio Sì
instanceName Parametro percorso Nome istanza Sì
services Parametro della query

Opzioni dei servizi [Tutti,App,Componenti, AllwithVM, AppswithVM]

 No

Risposta di esempio

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

Ottieni durate consentite

Utilizzare questa API per ottenere le durate consentite per i ticket di mancato recapito.

API

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

Ambito e AuthZ

  • Per accedere a questa API, è necessario disporre dell'ambito mcs:oci:api:User.
  • È possibile utilizzare l'API dei metadati di mancato recapito solo se il cliente ha optato per la funzionalità di mancato recapito.

Intestazioni

  • Autorizzazione: Bearer <Token>

    Dove <Token> è il token OAUTH restituito dal server di autorizzazione (token JWT).

  • Identificativo: <ID JWKS>

    Dove <JWKS Identifier> è il GUID generato quando l'URI JWKS è impostato dall'amministratore del cliente nella piattaforma self-service.

Percorso di base

/selfservice/v1/

Funzionalità

  • Questa API espone l'elenco delle operazioni di mancato recapito consentite.
  • displayValue è il valore utilizzato per la visualizzazione.
  • value è il valore considerato per l'elaborazione.

Verbo

GET

Risposta di esempio

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