Consulta de instâncias de BD
Função
Essa API é usada para consultar instâncias de BD de acordo com critérios de pesquisa. Antes de chamar essa API:

Esta API estará indisponível em 31 de dezembro de 2025. É aconselhável mudar as cargas de trabalho para a nova API (Consulta de instâncias de BD) antes disso.
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
URI
GET /v3/{project_id}/instances
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 |
|---|---|---|---|
id | Não | String | ID da instância. O asterisco (*) é reservado para o sistema. Se o ID da instância começar com *, isso indica que a correspondência difusa é executada com base no valor seguinte a *. Caso contrário, a correspondência exata é executada com base no ID da instância. O valor não pode conter apenas asteriscos (*). |
name | Não | String | Nome da instância. O asterisco (*) é reservado para o sistema. Se o nome da instância começar com *, isso indica que a correspondência difusa é executada com base no valor seguinte a *. Caso contrário, a correspondência exata é executada com base no nome da instância. O valor não pode conter apenas asteriscos (*). |
type | Não | String | Tipo de instância a ser consultada. Atualmente, apenas o tipo de cluster é suportado. |
datastore_type | Não | String | Tipo do BD. Atualmente, apenas o gaussdb-mysql é suportado. |
vpc_id | Não | String | ID de VPC |
subnet_id | Não | String | ID de rede da sub-rede. |
private_ip | Não | String | Endereço IP privado. |
readonly_private_ip | Não | String | Endereço IP privado para leitura. |
proxy_ip | Não | String | Endereço de divisão de leitura/gravação. |
offset | Não | Integer | 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 | Não | Integer | 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. |
tags | Não | String | Consulta com base na chave e no valor da tag da instância.
Para consultar instâncias com várias chaves e valores de tag, separe os pares chave-valor com vírgulas (,). A chave deve ser exclusiva. Várias chaves estão na relação AND. |
Parâmetros de solicitação
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
X-Auth-Token | Sim | String | Token do usuário. Para obter esse valor, chame a API do IAM para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. |
X-Language | Não | String | Tipo de linguagem da solicitação. O valor padrão é en-us. Valores:
|
Parâmetros de resposta
Código de status: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
instances | Array of MysqlInstanceListInfo objects | Informações da lista de instâncias. |
total_count | Integer | Número total de registros. |
Parâmetro | Tipo | Descrição |
|---|---|---|
id | String | ID da instância. |
name | String | Nome da instância. |
status | String | Status da instância. |
private_ips | Array of strings | Endereço IP privado para gravação. Ele é deixado em branco até que um ECS seja criado. |
readonly_private_ips | Array of strings | Endereços IP privados para leitura. Ele é deixado em branco até que um ECS seja criado. |
proxy_ips | Array of strings | Endereços IP de divisão de leitura/gravação. Ele é deixado em branco até que instâncias de proxy sejam criadas para uma instância. |
public_ips | Array of strings | 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 BD é implementada. |
datastore | MysqlDatastore object | Informações do banco de dados. |
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. 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. |
updated | String | Hora da atualização. O formato é o mesmo do campo created. 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. |
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. |
flavor_info | MysqlFlavorInfo object | Informações sobre flavors. |
volume | MysqlVolumeInfo object | Informações do disco de armazenamento. |
backup_strategy | MysqlBackupStrategy object | Política de backup automatizado. |
enterprise_project_id | String | ID do projeto empresarial. |
time_zone | String | Fuso horário. |
charge_info | MysqlChargeInfo object | Modo de cobrança, que é anual/mensal ou pagamento por uso (configuração padrão). |
dedicated_resource_id | String | ID do pool de recursos dedicado. Esse parâmetro é retornado somente quando a instância pertence a um pool de recursos dedicado. |
tags | Array of InstanceTagItem objects | Lista de tags. |
Parâmetro | Tipo | Descrição |
|---|---|---|
type | String | Mecanismo de BD. Atualmente, apenas gaussdb-mysql é suportado. |
version | String | Versão de BD. Para obter detalhes sobre as versões suportadas do mecanismo de BD, chame a API para consultar as versões do mecanismo de BD. |
kernel_version | String | Versão do kernel do banco de dados. |
Parâmetro | Tipo | Descrição |
|---|---|---|
vcpus | String | Número de vCPUs. |
ram | String | Tamanho da memória em GB. |
Parâmetro | Tipo | Descrição |
|---|---|---|
type | String | Tipo de disco. |
size | String | Tamanho do disco usado em GB. |
Parâmetro | Tipo | Descrição |
|---|---|---|
start_time | String | Hora de início do backup automatizado. O backup automatizado será acionado dentro de uma hora após o horário especificado por este parâmetro. O valor não pode ser vazio. Deve ser um valor válido no formato "hh:mm-HH:MM". A hora atual está no formato UTC.
|
keep_days | String | Dias de retenção de backup automatizado. Intervalo de valores: 1-732. |
Parâmetro | Tipo | Descrição |
|---|---|---|
charge_mode | String | Modo de cobrança. Valores:
|
period_type | String | Período de assinatura. Este parâmetro está disponível e é obrigatório apenas quando charge_mode é definido como prePaid. Valores:
|
period_num | Integer | Esse parâmetro é válido e obrigatório somente quando charge_mode é definido como prePaid. Valores:
|
is_auto_renew | String | Se a renovação automática está ativada para instâncias de BD anuais/mensais. O período de renovação é o mesmo que o período original e o pedido será pago automaticamente durante a renovação da assinatura.
|
is_auto_pay | String | Se o pedido será pago automaticamente após a criação de instâncias anuais/mensais. Este parâmetro não afeta o método de pagamento de renovação automática.
|
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
Consulta de instâncias do TaurusDB cujos endereços IP privados são 192.168.0.142
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=hyAbc&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1 Exemplo de resposta
Código de status: 200

O valor de region é usado como um exemplo na resposta a seguir.
Bem-sucedido.
{
"total_count" : 1,
"instances" : [ {
"id" : "d738399de028480fabb2b8120d4e01a4in07",
"name" : "gaussdb-mysql-instance01",
"status" : "ACTIVE",
"port" : 3306,
"type" : "Cluster",
"private_ips" : [ "192.168.0.142" ],
"db_user_name" : "root",
"region" : "aaa",
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0",
"kernel_version" : "2.0.29.1"
},
"created" : "2018-08-20T02:33:49_0800",
"updated" : "2018-08-20T02:33:49_0800",
"volume" : {
"type" : "POOL",
"size" : 100
},
"vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58",
"subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad",
"security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55",
"flavor_ref" : "gaussdb.mysql.xlarge.x86.4",
"flavor_info" : {
"vcpus" : 4,
"ram" : 16
},
"backup_strategy" : {
"start_time" : "19:00-20:00",
"keep_days" : 7
},
"charge_info" : {
"charge_mode" : "postPaid"
},
"enterprise_project_id" : 0,
"time_zone" : "UTC",
"tags" : [ ]
} ]
} Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.

