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.
Central de ajuda/ Document Database Service/ Referência de API/ APIs V3.0 (recomendada)/ Configuração de parâmetros/ Aplicação de um modelo de parâmetros
Atualizado em 2023-05-06 GMT+08:00
Ver PDF
Compartilhar

Aplicação de um modelo de parâmetros

Descrição

Essa API é usada para alterar um modelo de parâmetros para uma instância de banco de dados especificada.

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

    PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply

  • Exemplo de URI

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/apply

Tabela 1 Parâmetros de solicitação

Nome

Tipo

Obrigatório

Descrição

x-auth-token

String

Sim

Token do usuário

project_id

String

Sim

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

config_id

String

Sim

ID do modelo de parâmetro.

Solicitações

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

    Nome

    Obrigatório

    Tipo

    Descrição

    entity_ids

    Sim

    Array of strings
    IDs de instância, IDs de grupo ou IDs de nó. Você pode chamar a API usada para consultar instâncias e detalhes para obter o valor. Se você não tiver uma instância, poderá chamar a API usada para criar uma instância.
    • Se o tipo de instância de banco de dados for cluster e o modelo de parâmetro shard ou config for alterado, o valor será o ID do grupo. Se o modelo de parâmetro do nó mongos for alterado, o valor será o ID do nó.
    • Se a instância de banco de dados a ser alterada for uma instância do conjunto de réplicas ou uma instância de nó único, o valor será o ID da instância.
  • Exemplo de solicitação 
    {
  "entity_ids": [
    "73ea2bf70c73497f89ee0ad4ee008aa2no02"
  ]
}

Respostas

  • Descrição do parâmetro
    Tabela 3 Parâmetros de corpo da resposta

    Nome

    Tipo

    Descrição

    job_id

    String

    Indica o ID da tarefa assíncrona para aplicar um modelo de parâmetro.
  • Exemplo de resposta 
    { 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
}

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.

Tópico principal: Configuração de parâmetros