Obtenção de detalhes sobre um modelo de parâmetros

Descrição

Essa API é usada para obter detalhes de parâmetros de um modelo de parâmetros especificado.

Restrições

Esta API aplica-se 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/{config_id}

• Exemplo de URI

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

Solicitações

Nenhuma

Respostas

• Descrição do parâmetro

  Tabela 2 Parâmetros de corpo da resposta

  Nome	Tipo	Descrição
  id	String	O ID do modelo de parâmetro.
  name	String	Nome do modelo de parâmetro.
  datastore_version	String	Versão de banco de dados.
  datastore_name	String	Tipo de banco de dados.
  description	String	A descrição do modelo de parâmetro.
  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.
  parameters	Array of objects	Os parâmetros definidos pelos usuários com base nos modelos de parâmetro padrão. Para mais detalhes, consulte Tabela 3.

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

  Nome	Tipo	Descrição
  name	String	O nome do parâmetro.
  value	String	O valor do parâmetro.
  description	String	A descrição do parâmetro.
  type	String	Tipo de parâmetro. O valor pode ser integer, string, boolean, float ou list.
  value_range	String	Intervalo de valores. Por exemplo, o valor de inteiro é 0 ou 1, e o valor de boolean é true ou false.
  restart_required	Boolean	Se a instância precisa ser reiniciada. Se o valor for true, será necessário reiniciar. Se o valor for false, a reinicialização não é necessária.
  readonly	Boolean	Se o parâmetro é somente leitura. Se o valor for true, o parâmetro é somente leitura. Se o valor for false, o parâmetro não é somente leitura.

• Exemplo de resposta

  {
    "id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
    "name": "paramsGroup-test",
    "description": "",
    "datastore_name": "mongodb",
    "datastore_version": "4.0",
    "created": "2017-01-01T10:00:00",
    "updated": "2017-01-01T10:00:00",
    "parameters": [
      {
        "name": "cursorTimeoutMillis",
        "type": "integer",
        "value": 600000,
        "description": "Specify the expiration time of idle cursors. DDS will delete idle cursors.",
        "value_range": "600000-1000000",
        "restart_required": false,
        "readonly": false
      }
    ]
  }

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.