Documentação do Oracle Cloud Infrastructure

Especificações da API de Status de Workflow

Use a API de Status de Workflow para obter informações sobre o status de execução. Essa API pode ser usada para obter o status principal da execução ou o status detalhado de uma execução.

Os seguintes recursos são suportados:

Obter Status de Workflow

Use essa API para obter o status de workflow da execução.

API

/selfservice/v1/executions/status

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode obter o status das execuções criadas pelo seu cliente.
  • Você só pode obter o status de execução da funcionalidade de autoatendimento que o cliente aceitou.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

  • Essa API expõe o status de workflow das execuções.
  • executionId é o ID da execução.
  • status é o status principal da execução em questão.

Verbo

GET

Parâmetros

Nome Tipo Descrição Obrigatório
id Parâmetro de consulta

ID da Execução.

  • Para CEMLI, BOUNCE e CONFIG, use o número da RFC.

  • Para início/interrupção de VM, Exadata e verificação de integridade, use o ID da Execução.

Observação:

Vários IDs podem ser especificados no seguinte formato:

/selfservice/v1/executions/status ?id=<id1>&id=<id2>&...

Pelo menos um ID precisa ser informado.
requestor Parâmetro de consulta

Nome da funcionalidade que chama a API. Por exemplo, EXADATA_CPU_SCALE para a funcionalidade de Expansão ou Redução do Exadata.

Estes são os valores de solicitante:
Funcionalidade Solicitante
Cemli CEMLI
Bounce BOUNCE
Configuração CONFIG
Início/interrupção de VM BOUNCE_VM
Expansão ou Redução do Exadata EXADATA_CPU_SCALE
Verificação de integridade da instância INSTANCE_HEALTHCHECK
Sim

Resposta de amostra

{
"response": [
    {
        "executionId": "3-BLFVC0W",
        "status": "success"
    },
    {
        "executionId": "3-XTFVC0W",
        "status": "success"
    }
  ]
}

Obter Detalhes de Status de Workflow

Use essa API para obter detalhes de status de workflow.

API

/selfservice/v1/executions/{id}/status/details

Escopo e AuthZ

  • Você deve ter o escopo mcs:oci:api:User para acessar essa API.
  • Você só pode obter detalhes de status das execuções criadas pelo seu cliente.
  • Você só pode obter o status de execução da funcionalidade de autoatendimento que o cliente aceitou.

Cabeçalhos

  • Autorização: <Token> do Portador

    Em que <Token> é o token OAUTH retornado pelo Servidor de Autorização (Token JWT).

  • Identificador: <Identificador JWKS>

    Em que <Identificador JWKS> é o GUID gerado quando o URI do JWKS é definido pelo administrador do cliente na plataforma de autoatendimento.

Caminho Base

/selfservice/v1/

Funcionalidade

  • Essa API expõe os detalhes de status de workflow das execuções.
  • executionId é o ID da execução.
  • stepId é o ID da etapa atual usado para identificar etapas secundárias da etapa em questão. Se não for aprovada, a etapa será tratada como etapa raiz.
  • subSteps.stepId é o ID de etapa para uma subetapa usado em chamadas de API subsequentes para identificar as etapas secundárias da etapa em questão.
  • subSteps.endTime é o horário em que determinado marco foi concluído.
  • subSteps.hasSubStep indica se determinado subetapa tem etapas secundárias
  • subSteps.name é o nome do marco.
  • subSteps.status é o status do marco em questão para a RFC.
  • subSteps.remark são os logs do marco em questão.

Verbo

GET

Parâmetros

Nome Tipo Descrição Obrigatório
id Parâmetro de consulta

ID da Execução.

  • Para CEMLI, BOUNCE e CONFIG, use o número da RFC.

  • Para início/interrupção de VM, Exadata e verificação de integridade, use o ID da Execução.

 Sim
stepId Parâmetro de consulta Esse parâmetro indica o ID da etapa atual. Este parâmetro é usado para identificar etapas secundárias para uma Etapa em questão. Se não for aprovada, a etapa será tratada como etapa raiz.

Não

O padrão é 0
requestor Parâmetro de consulta

Nome da funcionalidade que chama a API. Por exemplo, EXADATA_CPU_SCALE para a funcionalidade de Expansão ou Redução do Exadata.

Estes são os valores de solicitante:
Funcionalidade Solicitante
Cemli CEMLI
Bounce BOUNCE
Configuração CONFIG
Início/interrupção de VM BOUNCE_VM
Expansão ou Redução do Exadata EXADATA_CPU_SCALE
Verificação de integridade da instância INSTANCE_HEALTHCHECK
Sim

Resposta de amostra

{
    "executionId": "3-7JZXAGH",
    "stepId": 0,
    "subSteps": [
        {
            "endTime": "2021-04-21T01:56:24Z",
            "hasSubStep": true,
            "name": "RFC Submission",
            "startTime": "2021-04-21T01:52:24Z",
            "status": "Completed",
            "stepId": 159,
            "remark": "RFC successfully submitted to workflow engine"
        },
        {
            "endTime": "2021-04-21T01:59:24Z",
            "hasSubStep": false,
            "name": "RFC Execution",
            "startTime": "2021-04-21T01:52:24Z",
            "status": "Queued",
            "stepId": 236,
            "remark": "RFC successfully executed"
        }
    ]
}