Criação de um modelo de parâmetro
Função
Essa API é usada para criar um modelo de parâmetro. As seguintes informações precisam ser configuradas: nome do modelo, descrição, versão do mecanismo de BD e valores de parâmetro. Antes de chamar essa API:
- Saiba como autorizá-la e autenticá-la.
- Obtenha a região e o ponto de extremidade necessários.
Restrições
- Esta API está disponível apenas para instâncias primárias/em espera (edição dedicada) do GaussDB(for MySQL).
- O nome do modelo de parâmetro personalizado diferencia maiúsculas de minúsculas e deve ser diferente do nome de um modelo de parâmetro padrão ou existente.
- O valor de parameter_values no modelo de parâmetro personalizado deve estar dentro do intervalo de valores padrão da versão do banco de dados especificada.
URI
POST /v3/{project_id}/configurations
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto de um locatário em uma região. Para obter esse valor, consulte Obtenção de um ID de projeto. |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
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:
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
name |
Sim |
String |
Nome do modelo de parâmetro. Valor: O nome do modelo pode conter de 1 a 64 caracteres. Somente letras (diferenciam maiúsculas de minúsculas), dígitos, hifens (-), sublinhados (_) e pontos (.) são permitidos. |
description |
Não |
String |
Descrição do modelo de parâmetro. O valor é deixado em branco por padrão. Valor: A descrição pode conter até 256 caracteres e não pode conter os caracteres de retorno de carro ou caracteres especiais (!<"='>&). |
parameter_values |
Não |
Map<String,String> |
Mapeamento entre nomes de parâmetros e valores de parâmetros. Você pode especificar valores de parâmetro com base em um modelo de parâmetro padrão. |
datastore |
Não |
DatastoreResult object |
Objeto de banco de dados. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
type |
Sim |
String |
Mecanismo de BD. Atualmente, apenas gaussdb-mysql é suportado. |
version |
Sim |
String |
Versão de BD. Para obter detalhes sobre as versões de BD suportadas, consulte Consulta de informações de versão sobre um mecanismo de BD. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
configurations |
ConfigurationSummary2 object |
Informações do modelo de parâmetro. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID do modelo de parâmetro. |
name |
String |
Nome do modelo de parâmetro. |
description |
String |
Descrição do modelo de parâmetro. |
datastore |
DatastoreResult object |
Objeto de banco de dados. |
created |
String |
Tempo de criação no formato "aaaa-MM-ddTHH:mm:ssZ". T é o separador entre calendário e notação horária de tempo. Z indica o deslocamento do fuso horário. |
updated |
String |
Hora de atualização no formato "aaaa-MM-ddTHH:mm:ssZ". T é o separador entre calendário e notação horária de tempo. Z indica o deslocamento do fuso horário. |
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 de BD suportadas, consulte Consulta de informações de versão sobre um mecanismo de BD. |
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
Criação de um modelo de parâmetro (há até 10 conexões simultâneas para a conta.)
POST https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/configurations { "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "parameter_values" : { "max_user_connections" : "10" } }
Exemplo de resposta
Código de status: 200
Bem-sucedido.
{ "configurations" : { "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr07", "name" : "myparameter", "description" : "parameter1", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "created" : "2022-05-15T11:53:34+0000", "updated" : "2022-05-15T11:53:34+0000" } }
Código de status
Para mais detalhes, consulte Códigos de status.
Código de erro
Para mais detalhes, consulte Códigos de erro.