Cancelamento de uma tarefa programada
Função
Essa API é usada para cancelar uma tarefa agendada. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
DELETE /v3/{project_id}/scheduled-jobs
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário em uma região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token do usuário. Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token. |
X-Language |
Não |
String |
Tipo de linguagem da solicitação. O valor padrão é en-us. Valor:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
job_ids |
Sim |
Array of strings |
ID da tarefa. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
job_ids |
Array of strings |
ID da tarefa para cancelar uma tarefa agendada. |
Código de status: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Código de status: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error_code |
String |
Código de erro. |
error_msg |
String |
Mensagem de erro. |
Exemplo de solicitação
Cancelamento de uma tarefa agendada
DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs { "job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ] }
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ] }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.