Obtenção de informações de parâmetro de uma instância de banco de dados especificada
Função
Essa API é usada para obter informações de parâmetros de uma instância de banco de dados especificada. 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}/instances/{instance_id}/configurations
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Explicação: ID do projeto de um locatário numa região. Para obter esse valor, consulte Obtenção de um ID de projeto. Restrições: Nenhuma Intervalo de valores: O valor pode conter 32 caracteres. Apenas letras e dígitos são permitidos. Valor padrão: Nenhum |
instance_id |
Sim |
String |
Explicação: ID da instância, que identifica exclusivamente uma instância. Restrições: Nenhuma Intervalo de valores: O valor pode conter 36 caracteres com um sufixo de in07. Apenas letras e dígitos são permitidos. Valor padrão: Nenhum |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
offset |
Não |
Integer |
Explicação: Deslocamento do índice. A consulta começa a partir da próxima parte dos dados indexados por este parâmetro. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: ≥0 Valor padrão: 0 |
limit |
Não |
Integer |
Explicação: Número de registros a serem consultados. Restrições: O valor deve ser um número inteiro e não pode ser um número negativo. Intervalo de valores: 1–100 Valor padrão: 100 |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Explicação: Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o valor do token. Restrições: Nenhuma Intervalo de valores: Nenhum Valor padrão: Nenhum |
X-Language |
Não |
String |
Explicação: Tipo de linguagem da solicitação. Restrições: Nenhuma Intervalo de valores:
Valor padrão: en-us |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
configurations |
ParameterConfigurationInfo object |
Explicação: Informações do modelo de parâmetro de instância. |
total_count |
Long |
Explicação: Número total de parâmetros de instância. Intervalo de valores: ≥0 |
parameter_values |
Array of ParameterValuesInfo objects |
Explicação: Informações de parâmetro da instância. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
datastore_version_name |
String |
Explicação: Nome da versão do BD. Intervalo de valores: 2.0 |
datastore_name |
String |
Explicação: Nome do mecanismo de BD no modelo de parâmetro. Intervalo de valores: taurus |
created |
String |
Explicação: Hora em que o modelo de parâmetro foi criado. O 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. Intervalo de valores: Nenhum |
updated |
String |
Explicação: Hora em que o modelo de parâmetro foi atualizado. O 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. Intervalo de valores: Nenhum |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
Explicação: Nome do parâmetro. Intervalo de valores: Nenhum |
value |
String |
Explicação: Valor do parâmetro. Intervalo de valores: Nenhum |
restart_required |
Boolean |
Explicação: Se uma reinicialização é necessária. Intervalo de valores:
|
readonly |
Boolean |
Explicação: Se o parâmetro é somente leitura. Intervalo de valores:
|
value_range |
String |
Explicação: Intervalo de valores. Intervalo de valores: Nenhum |
type |
String |
Explicação: Tipo de parâmetro. Intervalo de valores:
|
description |
String |
Explicação: Descrição do parâmetro. Intervalo de valores: Nenhum |
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 informações de parâmetro de uma instância de banco de dados especificada
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/configurations
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "configurations" : { "datastore_version_name" : 2.0, "datastore_name" : "taurus", "created" : "2022-10-29T09:38:36+0000", "updated" : "2022-10-29T09:38:36+0000" }, "total_count" : 125, "parameter_values" : [ { "name" : "auto_increment_increment", "value" : 1, "restart_required" : false, "readonly" : false, "value_range" : "1-65535", "type" : "integer", ...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column. }, { "name" : "auto_increment_offset", "value" : 1, "restart_required" : false, "readonly" : false, "value_range" : "1-65535", "type" : "integer", ...."description": auto_increment_increment and auto_increment_offset are used for master-to-master replication and to control the operations of the AUTO_INCREMENT column. } ] }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.