Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Relational Database Service/ Referência de API/ API v3 (recomendada)/ Obtenção de informações de tarefa/ Obtenção de informações sobre uma tarefa com um ID especificado
Atualizado em 2023-05-05 GMT+08:00

Obtenção de informações sobre uma tarefa com um ID especificado

Função

Esta API é usada para obter informações sobre uma tarefa com um ID especificado no centro de tarefas.

  • Antes de chamar uma API, você precisa entender a API em Autenticação.

Restrições

  • Os trabalhos do RDS são assíncronos. Depois que um trabalho é gerado, leva vários segundos para consultar o ID da tarefa.
  • Esta API é usada para consultar apenas trabalhos assíncronos do último mês no centro de tarefas.
  • Informações das seguintes tarefas assíncronas podem ser obtidas: criação de instâncias de banco de dados únicas ou primárias/em espera, criação de réplicas de leitura, exclusão de instâncias de banco de dados, alteração de instâncias de banco de dados únicas para instâncias primárias/em espera, alteração de instâncias de banco de dados primárias/em espera, expansão do espaço de armazenamento, restauração para uma nova instância de banco de dados, migração de uma instância de banco de dados em espera do RDS for MySQL, atualização de uma versão secundária de uma instância de banco de dados do RDS for MySQL, restauração de dados ao nível de tabela para um ponto de tempo especificado para uma instância de banco de dados do RDS for MySQL e vinculação ou desvinculação de EIPs.

URI

  • Formato de URI

    GET /v3/{project_id}/jobs?id={id}

  • Descrição do parâmetro
    Tabela 1 Descrição do parâmetro

    Nome

    Obrigatório

    Descrição

    project_id

    Sim

    Especifica o ID do projeto de um locatário em uma região.

    Para obter detalhes sobre como obter o ID do projeto, consulte Obtenção de um ID de projeto.

    id

    Sim

    Especifica o ID da tarefa.

Solicitação

  • Parâmetros de solicitação

    Nenhum

  • Exemplo de URI

    GET https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

Resposta

  • Resposta normal
    Tabela 2 Descrição do parâmetro

    Nome

    Tipo

    Descrição

    job

    Object

    Indica as informações da tarefa. Para mais detalhes, consulte Tabela 3.

    Tabela 3 Descrição da estrutura de dados do campo job

    Nome

    Tipo

    Descrição

    id

    String

    Indica o ID do trabalho.

    name

    String

    Indica o nome da tarefa.

    status

    String

    Indica o status de execução da tarefa.

    Valor:
    • Running: a tarefa está sendo executada.
    • Completed: a tarefa foi executada com sucesso.
    • Failed: a tarefa falhou ao ser executada.

    created

    String

    Indica o tempo de criação no formato "yyyy-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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.

    ended

    String

    Indica a hora de fim no formato "yyyy-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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.

    process

    String

    Indica o andamento da execução da tarefa.

    NOTA:

    O andamento da execução (como "60%") é exibido somente quando a tarefa está sendo executada. Caso contrário, "" é retornado.

    instance

    Object

    Indica informações da instância de banco de dados na qual a tarefa é executada.

    Para mais detalhes, consulte Tabela 4.

    entities

    Object

    As informações exibidas variam dependendo das tarefas.

    Para obter detalhes, consulte o seguinte:

    NOTA:

    para tarefas assíncronas sem a descrição do campo entities, {} é retornado.

    fail_reason

    String

    Indica as informações de erro exibidas quando uma tarefa falhou.

    Tabela 4 Descrição da estrutura de dados do campo instances

    Nome

    Tipo

    Descrição

    id

    String

    Indica o ID da instância de banco de dados.

    name

    String

    Indica o nome da instância de banco de dados.

    Tabela 5 Descrição da estrutura de dados do campo entities (criação de instâncias de banco de dados, alteração de instâncias de banco de dados únicas para primárias/em espera ou criação de réplicas de leitura)

    Nome

    Tipo

    Descrição

    instance

    Object

    Indica as informações sobre a instância de banco de dados consultada.

    Para mais detalhes, consulte Tabela 6.

    resource_ids

    List<String>

    Indica o ID do recurso consultado.

    Tabela 6 Descrição da estrutura de dados do campo entities.instance

    Nome

    Tipo

    Descrição

    endpoint

    String

    Indica o endereço de conexão da instância de banco de dados.

    type

    String

    O valor é Single, Ha, ou Replica, indicando a instância de banco de dados única, as instâncias de banco de dados primárias/em espera e a réplica de leitura, respectivamente.

    datastore

    Object

    Indica as informações de banco de dados. Para mais detalhes, consulte Tabela 7.

    replica_of

    String

    Indica o ID da instância de banco de dados primária. Este parâmetro é retornado somente quando uma réplica de leitura é criada.

    Tabela 7 Descrição da estrutura de dados do campo datastore

    Nome

    Tipo

    Descrição

    type

    String

    Indica o mecanismo de banco de dados.

    version

    String

    Indica a versão de banco de dados.

    Tabela 8 Descrição da estrutura de dados do campo entities (redimensionamento de uma instância de banco de dados)

    Nome

    Tipo

    Descrição

    volume

    Object

    Indica as informações sobre o disco redimensionado.

    Para mais detalhes, consulte Tabela 9.

    resource_ids

    List<String>

    Indica o ID do recurso consultado.

    Tabela 9 Descrição da estrutura de dados do campo volume

    Nome

    Tipo

    Descrição

    type

    String

    Indica o tipo de volume.

    original_size

    String

    Indica o tamanho do volume original em GB.

    target_size

    String

    Indica o tamanho do volume de destino em GB.

    Tabela 10 Descrição da estrutura de dados do campo entities (vinculação/desvinculação de EIPs ou ativação/desativação de acesso remoto)

    Nome

    Tipo

    Descrição

    public_ip

    String

    Indica o EIP vinculado à instância de banco de dados.

    Tabela 11 Descrição da estrutura de dados do campo entities (comutação principal/em espera)

    Nome

    Tipo

    Descrição

    switch_strategy

    String

    Indica a política de alteração primária/em espera.

    No exemplo de resposta, algumas tarefas no centro de tarefas são usadas como exemplos.

  • Exemplo de resposta normal
    Criação de instâncias de banco de dados:
    {
    	"job": {
    		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
    		"name": "CreateMysqlSingleHAInstance",
    		"status": "Completed",
    		"created": "2018-08-06T10:41:14+0000",
    		"ended": "2018-08-06T16:41:14+0000",
    		"process": "",
    		"instance": {
    			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
    			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
    		},
    		"entities": {
    			"instance": {
    				"endpoint": "192.168.1.203:3306",
    				"type": "Single",
    				"datastore": {
    					"type": "mysql",
    					"version": "5.7"
    				}
    			},
    			"resource_ids": ["a48e43ff268f4c0e879652d65e63d0fbin01.vm", "a48e43ff268f4c0e879652d65e63d0fbin01.volume"]
    		}
    	}
    }
    Criação de uma réplica de leitura:
    {
    	"job": {
    		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
    		"name": " CreateMysqlReplicaInstance",
    		"status": "Completed",
    		"created": "2018-08-06T10:41:14+0000",
    		"ended": "2018-08-06T16:41:14+0000",
    		"process": "",
    		"instance": {
    			"id": "288caaa9d05f4ec1a1f58de2e0945685in01",
    			"name": "mysql-replica"
    		},
    		"entities": {
    			"instance": {
    				"endpoint": "192.168.1.203:3306",
    				"type": "replica",
    				"datastore": {
    					"type": "mysql",
    					"version": "5.7"
    				},
    				"replica_of": "a48e43ff268f4c0e879652d65e63d0fbin01"
    			},
    			"resource_ids": ["288caaa9d05f4ec1a1f58de2e0945685in01.vm", "288caaa9d05f4ec1a1f58de2e0945685in01.volume"]
    		}
    	}
    }
    Vinculação de um EIP:
    {
    	"job": {
    		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
    		"name": "MysqlBindEIP",
    		"status": "Completed",
    		"created": "2018-08-06T10:41:14+0000",
    		"ended": "2018-08-06T16:41:14+0000",
    		"process": "",
    		"instance": {
    			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
    			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
    		},
    		"entities": {
    			"public_ip": "10.154.218.254"
    		}
    	}
    }
    Reinicialização de uma instância de banco de dados:
    {
    	"job": {
    		"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
    		"name": " RestartMysqlInstance",
    		"status": "Completed",
    		"created": "2018-08-06T10:41:14+0000",
    		"ended": "2018-08-06T16:41:14+0000",
    		"process": "",
    		"instance": {
    			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
    			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
    		},
    		"entities": {}
    	}
    }
    Tarefa que está sendo executada:
    {
    	"job": {
    		"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
    		"name": "CreateMysqlSingleHAInstance"," status": "Running",
    		"created": "2018-08-06T10:41:14+0000",
    		"process": "60% ",
    		"instance": {
    			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
    			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
    		},
    		"entities": {
    			"instance": {
    				"type": "Single",
    				"datastore": {
    					"type": "mysql",
    					"version": "5.7"
    				}
    			}
    		}
    	}
    }
    A tarefa falhou ao ser executada:
    {
    	"job": {
    		"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
    		"name": "CreateMysqlSingleHAInstance",
    		"status": "Failed",
    		"created": "2018-08-06T10:41:14+0000",
    		"ended": "2018-08-06T16:41:14+0000",
    		"process": "",
    		"instance": {
    			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
    			"name": "DO-NOT-TOUCH-mgr2-mysql-single"
    		},
    		"entities": {
    			"instance": {
    				"type": "Single",
    				"datastore": {
    					"type": "mysql",
    					"version": "5.7"
    				}
    			}
    		},
    		"fail_reason": "createVM failed."
    	}
    }
    {
    	"job": {
    		"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
    		"name": "CreatePostgresqlSingleHAInstance",
    		"status": "Failed",
    		"created": "2018-08-06T10:41:14+0000",
    		"ended": "2018-08-06T16:41:14+0000",
    		"process": "",
    		"instance": {
    			"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
    			"name": "DO-NOT-TOUCH-mgr2-postgresql-single"
    		},
    		"entities": {
    			"instance": {
    				"type": "Single",
    				"datastore": {
    					"type": "postgresql",
    					"version": "9.6"
    				}
    			}
    		},
    		"fail_reason": "createVM failed."
    	}
    }
  • Resposta anormal

    Para mais detalhes, consulte Resultados anormais da solicitação.

Código de status

Código de erro

Para mais detalhes, consulte Códigos de erro.