Consulta de instâncias de BD

Função

Essa API é usada para consultar instâncias de acordo com critérios de pesquisa. Antes de chamar essa API:

Essa API estará indisponível em 31 de março de 2024.

• Saiba como autorizá-la e autenticá-la.
• Obtenha a região e o ponto de extremidade necessários.

URI

• Formato de URI

  GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}

• Exemplo

  GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

• Descrição do parâmetro

  Tabela 1 Descrição do parâmetro

  Nome	Tipo	Obrigatório	Descrição
  project_id	String	Sim	ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto.
  id	String	Não	ID da instância de BD. O asterisco (*) é reservado para o sistema. Se o ID da instância começar com um asterisco (*), o valor após o asterisco (*) é usado para correspondência difusa. Caso contrário, o ID da instância é usado para correspondência exata.
  name	String	Não	Nome da instância de BD. O asterisco (*) é reservado para o sistema. Se o nome da instância começar com um asterisco (*), o valor após o asterisco (*) será usado para correspondência difusa. Caso contrário, o nome da instância é usado para correspondência exata.
  type	String	Não	Tipo de instância de banco de dados a ser consultado. Atualmente, apenas o tipo de cluster é suportado.
  datastore_type	String	Não	Tipo do BD. Atualmente, apenas o gaussdb-mysql é suportado.
  vpc_id	String	Não	ID de VPC Método 1: faça logon no console da VPC e visualize o ID da VPC na página de detalhes da VPC. Método 2: consulte "Consulta de VPCs" na Referência de API da Virtual Private Cloud.
  subnet_id	String	Não	ID de rede da sub-rede. Método 1: faça logon no console da VPC e clique na sub-rede de destino na página Subnets. Você pode visualizar o ID da rede na página exibida. Método 2: consulte "Consulta de sub-redes" na Referência de API da Virtual Private Cloud.
  offset	Integer	Não	Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo.
  limit	Integer	Não	Número de registros a serem consultados. O valor padrão é 100. o valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100.

Solicitação

Nenhuma.

Resposta

• Resposta normal

  Tabela 2 Descrição do parâmetro

  Nome	Tipo	Descrição
  instances	Array of objects	Informações da instância. Para mais detalhes, consulte Tabela 3.
  total_count	Integer	Número total de registros.

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

  Nome	Tipo	Descrição
  id	String	ID da instância de BD.
  name	String	Nome da instância de BD.
  status	String	Status da instância de BD.
  private_ips	List<String>	Endereço IP privado para gravação. É uma cadeia de caracteres em branco até que um ECS seja criado.
  public_ips	List<String>	Endereços IP públicos.
  port	String	Porta do banco de dados.
  type	String	Tipo de instância de BD. O valor é Cluster.
  region	String	Região onde a instância de banco de dados é implementada.
  datastore	Object	Informações do banco de dados. Para mais detalhes, consulte Tabela 4.
  created	String	Tempo de criação 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, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800. O valor fica vazio, a menos que a criação da instância esteja concluída.
  updated	String	Hora da atualização. O formato é o mesmo do campo created. O valor fica vazio, a menos que a criação da instância esteja concluída.
  db_user_name	String	Nome de usuário padrão.
  vpc_id	String	ID de VPC
  subnet_id	String	ID de rede da sub-rede.
  security_group_id	String	ID do grupo de segurança.
  flavor_ref	String	Código de especificação. Para mais detalhes, consulte Tabela 3.
  flavor_info	Object	Descrição da especificação.
  volume	Object	Informação do volume. Para mais detalhes, consulte Tabela 5.
  backup_strategy	Object	Política de backup. Para mais detalhes, consulte Tabela 7.
  enterprise_project_id	String	ID do projeto empresarial.
  time_zone	String	Fuso horário.
  charge_info	Object	Modo de cobrança, que é anual/mensal ou pagamento por uso. Por padrão, pagamento por uso é usado. Para mais detalhes, consulte Tabela 8.

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

  Nome	Tipo	Descrição
  type	String	Mecanismo de BD.
  version	String	Versão de BD.

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

  Nome	Tipo	Descrição
  type	String	Tipo de disco.
  size	String	Tamanho do disco usado em GB.

  Tabela 6 Descrição da estrutura de dados do campo flavor_ref

  Nome	Tipo	Descrição
  vcpus	String	Número de vCPUs.
  ram	String	Tamanho da memória em GB.

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

  Nome	Tipo	Descrição
  start_time	String	Janela de tempo de backup. Os backups automatizados serão acionados durante a janela de tempo de backup.
  keep_days	String	Dias de retenção de backup.

  Tabela 8 Descrição da estrutura de dados do campo charge_info

  Nome	Tipo	Descrição
  charge_mode	String	Modo de cobrança. Valor válido: prePaid: indica o modo de cobrança anual/mensal. postPaid: indica o modo de cobrança de pagamento por uso.

  

  O valor de region é usado como um exemplo na resposta a seguir.

• Exemplo de resposta normal

  {
      "total_count":6,
      "instances":[
          {
              "id":"d738399de028480fabb2b8120d4e01a4in07",
              "status":"ACTIVE",
              "name":"oMoS_001",
              "port":3306,
              "type":"Cluster",
              "private_ips": ["192.168.0.142"],
              "public_ips": ["10.154.219.187"],
              "db_user_name": "root",
              "region": "aaa",
              "datastore": {"type": "gaussdb-mysql", "version":"8.0"},
              "created": "2018-08-20T02:33:49+0800",
              "updated": "2018-08-20T02:33:50+0800",
              "volume": {
                      "type": "POOL",
                      "used_size": 100
              },                         
              "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
              "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
              "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902",
              "flavor_ref":"gaussdb.mysql.c3.small.4",
              "backup_strategy": {"start_time": "19:00-20:00", "keep_days": 7},                          
              "charge_info": {
                  "charge_mode": "postPaid"
              },
              "enterprise_project_id": "0",
                   "time_zone": "",
          }
      ]
  }

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.