Obtenção de tarefas agendadas
Função
Essa API é usada para obter as tarefas agendadas. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/scheduled-jobs
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
offset |
Não |
String |
Deslocamento do índice. A consulta começa a partir da primeira parte dos dados. O valor padrão é 0. O valor deve ser um número e não pode ser um número negativo. |
|
limit |
Não |
String |
Número de registros a serem consultados. O valor padrão é 10. |
|
status |
Não |
String |
Status de execução da tarefa. Valor:
|
|
start_time |
Não |
String |
Hora de início no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.  NOTA:
O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio. |
|
end_time |
Não |
String |
Hora de término no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. NOTA:
O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio. |
|
job_id |
Não |
String |
ID da tarefa. |
|
job_name |
Não |
String |
Tipo de agendamento de tarefas. |
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âmetros de resposta
Código de status: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
schedules |
Array of ScheduleTask objects |
Detalhes da tarefa. |
|
total_count |
Integer |
Número total de registros. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
job_id |
String |
ID da tarefa. |
|
instance_id |
String |
ID da instância. |
|
instance_name |
String |
Nome da instância. |
|
instance_status |
String |
Status da instância. Valor:
|
|
project_id |
String |
ID do projeto de um locatário numa região. |
|
job_name |
String |
Nome da tarefa. Valor:
|
|
create_time |
String |
Hora de criação da tarefa no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. NOTA:
O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio. |
|
start_time |
String |
Hora de início da tarefa no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. NOTA:
O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio. |
|
end_time |
String |
Hora de término da tarefa no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100. NOTA:
O valor fica vazio quando a instância de BD está sendo criada. Depois que a instância de BD é criada, o valor não está vazio. |
|
job_status |
String |
Status de execução da tarefa. Valor:
|
|
datastore_type |
String |
Tipo de banco de dados. |
|
target_config |
Object |
Informações de configuração da instância, como especificações. |
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
Obtenção de tarefas agendadas
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs?offset=1&limit=10Exemplo de resposta
Código de status: 200
Bem-sucedido.
{
"schedules" : [ {
"job_id" : "56d3c1138dcf4f1da73b0170700c78d0",
"instance_id" : "79bc540dd4d6432784894a981fdfacfcin07",
"instance_name" : "gauss-f821",
"instance_status" : "BUILD",
"project_id" : "053f533ead80d5102f0cc012e8d468a4",
"job_name" : "UpgradeGaussDBforMySQLDatabaseVersion",
"create_time" : "2018-08-06T10:41:14+0000",
"start_time" : "2018-08-06T10:41:14+0000",
"end_time" : "2018-08-06T10:41:14+0000",
"job_status" : "Completed",
"datastore_type" : "gaussdb-mysql",
"target_config" : {
"flavor" : "gaussdb.mysql.xlarge.arm.4",
"mem" : "16",
"cpu" : "4"
}
} ],
"total_count" : 1
}Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.
