Cancele o turno atual em execução de uma sessão Forward.
Cabeçalhos da requisição
|
Cabeçalho |
Obrigatório |
Descrição |
|
|
Sim |
|
|
|
Não |
Chave de idempotência opcional para requisições não seguras. |
Parâmetros de caminho
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
|
|
string |
Sim |
ID da sessão. |
Exemplo de requisição
curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/sessions/sess_xxx/cancel' \
-H "Authorization: Bearer $QODER_PAT"
Exemplo de resposta
HTTP 202 Accepted
{
"id": "sess_xxx",
"type": "session",
"status": "canceling"
}
Campos da resposta
|
Campo |
Tipo |
Descrição |
|
|
string |
ID da sessão. |
|
|
string |
Sempre |
|
|
string |
|
Erros
|
HTTP |
Tipo |
Código |
Gatilho |
|
401 |
|
|
PAT inválido ou expirado. |
|
404 |
|
|
A sessão não existe. |
|
409 |
|
|
Sessão arquivada. |
|
502 |
|
|
O service de sessão de runtime está indisponível. |
Observações
202 Acceptedindica que o cancelamento foi solicitado.200 OKsignifica que não há turno em execução para cancele.Confirme a conclusão pelo Event Stream ou consulte o status da sessão.