Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2023-05-06 GMT+08:00

Criação de um modelo de parâmetros

Descrição

Essa API é usada para criar um modelo de parâmetro e configurar o nome, a descrição, o mecanismo de banco de dados e os valores de parâmetro no modelo de parâmetro.

Restrições

  • Esta API aplica-se apenas ao DDS Community Edition.
  • 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 deve estar dentro do intervalo de valores padrão da versão do banco de dados especificada. Para obter detalhes sobre a faixa de valores de parâmetro, consulte Edição de um modelo de parâmetros no Guia de usuário do Document Database Service.

Depuração

Você pode depurar a API no API Explorer, que oferece suporte à autenticação automática. O API Explorer pode gerar e depurar automaticamente o código SDK de exemplo.

URI

  • Formato de URI

    POST https://{Endpoint}/v3/{project_id}/configurations

  • Exemplo de URI

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/configurations

Tabela 1 Parâmetros de solicitação

Nome

Tipo

IN

Obrigatório

Descrição

x-auth-token

string

header

Sim

Token do usuário

project_id

string

path

Sim

ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto.

Solicitações

  • Descrição do parâmetro
    Tabela 2 Parâmetros de corpo de solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    name

    String

    Sim

    Nome do modelo de parâmetro.

    Intervalo de valores: uma cadeia de 1 a 64 caracteres, que pode conter apenas letras, dígitos, hífens (-), sublinhado (_) e pontos (.).

    description

    String

    Sim

    Descrição do modelo de parâmetro. Este parâmetro é deixado em branco por padrão.

    A descrição deve consistir em um máximo de 256 caracteres e não pode conter o caractere de retorno de carro ou os seguintes caracteres especiais: >!<"&'=

    parameter_values

    Map<String,String>

    Sim

    Mapeamento entre nomes de parâmetros e valores de parâmetros. É possível personalizar valores de parâmetros com base nos parâmetros no modelo de parâmetro padrão.

    datastore

    Object

    Sim

    Objeto de banco de dados.

    Para mais detalhes, consulte Tabela 3.

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

    Nome

    Tipo

    Obrigatório

    Descrição

    node_type

    String

    Sim

    Tipo de nó do modelo de parâmetro node_type. Valor válido:
    • mongos: o tipo de nó de mongos.
    • shard: o tipo de nó de shard.
    • config: o tipo de nó de configuração.
    • replica: o tipo de conjunto de réplicas.
    • single: o tipo de nó único.

    version

    String

    Sim

    Versão do banco de dados. As versões 4.2, 4.0 e 3.4 são suportadas. O valor pode ser 4.2, 4.0 ou 3.4.

    NOTA:
    • O DDS 4.2 é restrito para uso comercial. Para obter detalhes, consulte Avisos do DDS.
    • Para garantir que você tenha uma boa experiência usando o DDS, crie uma instância do DDS 4.0.
  • Exemplo de solicitação
    { 
      "name" : "myparameter", 
      "description" : "parameter1", 
      "datastore" : { 
        "node_type" : "shard", 
        "version" : "3.4" 
      }, 
      "parameter_values" : { 
        "max_connections" : "10" 
      } 
    }

Respostas

  • Descrição do parâmetro
    Tabela 4 Descrição da estrutura de dados do campo configuration

    Nome

    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_version

    String

    Versão do banco de dados.

    datastore_name

    String

    Tipo de 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.

    updated

    String

    Hora de atualizaçã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.

  • Exemplo de resposta
    {
      "configuration": {
        "id": "7b4e07852bd54016906e89461b3182cdpr02",
        "name": "myparameter",
        "description": "parameter1",
        "datastore_version": "3.4",
        "datastore_name": "mongodb",
        "created": "2018-09-19T02:54:21",
        "updated": "2018-09-19T02:54:21"
      }
    }

SDK

Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.

Código de status

Para obter mais informações, consulte Código de status.

Código de erro

Para obter mais informações, consulte Código de erro.