Consulta de instâncias de BD

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.

id

Não

String

ID da instância. O asterisco (*) é reservado para o sistema. Se o ID da instância começar com *, 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 IP 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

Consultas com base nas chaves e valores da tag de instância.

• {key} indica a chave da tag.
• {value} indica o valor da tag.

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.

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:

• en-us
• zh-cn

instances

Array of MysqlInstanceListInfoUnifyStatus objects

Informações da lista de instâncias.

total_count

Integer

Número total de registros.

id

String

ID da instância, que é compatível com o formato UUID.

name

String

Nome da instância.

status

String

Status da instância.

Valor:

• creating: a instância de BD está sendo criada.
• normal: a instância está sendo executada corretamente.
• abnormal: a instância é anormal.
• createfail: falha ao criar a instância.

private_ips

Array of strings

Endereços IP privados para gravação. 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 as instâncias de proxy sejam criadas para uma instância de banco de dados.

readonly_private_ips

Array of strings

Endereços IP privados para leitura. Ele é deixado em branco até que um ECS seja criado.

public_ips

Array of strings

EIPs.

port

String

Porta do banco de dados.

type

String

Tipo de instância. O valor é Cluster.

region

String

Região onde a instância de banco de dados é implementada.

datastore

MysqlDatastoreWithKernelVersion 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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

updated

String

Hora da atualização. O formato é o mesmo do campo created.

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.

type

String

Mecanismo de BD. Atualmente, apenas o gaussdb-mysql é suportado.

version

String

Versão de BD.

kernel_version

String

Versão do kernel do banco de dados.

vcpus

String

Número de vCPUs.

ram

String

Tamanho da memória em GB.

type

String

Tipo de disco.

size

String

Tamanho do disco usado em GB.

start_time

String

Hora de início do backup automatizado. A criação de um backup automatizado será acionada 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.

1. O valor de HH deve ser 1 maior que o valor de hh.
2. Os valores de mm e MM devem ser os mesmos e devem ser definidos como 00.

keep_days

String

Dias de retenção de backup automatizado. Valor: 1-732.

charge_mode

String

Modo de cobrança.

Valor:

• prePaid: indica o modo de cobrança anual/mensal.
• postPaid: indica o modo de cobrança de pagamento por uso.

Valor:

• prePaid
• postPaid

period_type

String

Período de assinatura.

Valor:

• month: o serviço é assinado por mês.
• year: o serviço é assinado por ano.

Esse parâmetro é válido e obrigatório somente quando charge_mode é definido como prePaid.

Valor:

• month
• year

period_num

Integer

Esse parâmetro é válido e obrigatório somente quando charge_mode é definido como prePaid.

Valor:

• Quando period_type é definido como month, o valor do parâmetro varia de 1 a 9.
• Quando period_type é definido como year, o valor do parâmetro varia de 1 a 3.

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.

• true: indica que a renovação automática está ativada.
• false: indica que a renovação automática está desativada. O valor padrão é false.

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.

• true: indica que o pedido será pago automaticamente de sua conta. O valor padrão é true.
• false: indica que o pedido será pago manualmente.

key

String

Chave da tag.

value

String

Valor da tag.

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

200

Bem-sucedido.

400

Erro do cliente.

500

Erro no servidor.