Obtenção de modelos de parâmetros

Descrição

Essa API é usada para obter modelos de parâmetros, incluindo modelos de parâmetros padrão de todos os bancos de dados e modelos de parâmetros criados pelo usuário.

Restrições

Esta API se aplica apenas ao DDS Community Edition.

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

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

• Exemplo de URI

  https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations?offset=0&limit=100

Solicitações

Nenhuma

Respostas

• Descrição do parâmetro

  Tabela 3 Parâmetros de corpo da resposta

  Nome	Tipo	Descrição
  total_count	Integer	O número total de registros consultados.
  configurations	Array of objects	A lista de modelos de parâmetros. Para mais detalhes, consulte Tabela 4.

  Tabela 4 Descrição da estrutura de dados do campo configurations

  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_version	String	Versão do banco de dados.
  datastore_name	String	Tipo de banco de dados.
  node_type	String	Tipo de nó do modelo de parâmetro. 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.
  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.
  user_defined	Boolean	Indica se o modelo de parâmetro é criado pelos usuários. false: o modelo de parâmetro é um modelo de parâmetro padrão. true: o modelo de parâmetro é um modelo personalizado.

• Exemplo de resposta

  { 
    "total_count" : 1, 
    "configurations" : [ { 
      "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr01", 
      "name" : "test1", 
      "description" : "", 
      "datastore_name" : "mongos", 
      "node_type":"shard",
      "datastore_version" : "4.0", 
      "created" : "2017-01-01T10:00:00", 
      "updated" : "2017-01-01T10:00:00", 
      "user_defined" : true 
    } ] 
  }

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.