Consulta de especificações do banco de dados
Descrição da API
Essa API é usada para consultar todas as especificações de instância sob uma condição especificada.
Depuração
Você pode depurar essa API no API Explorer.
URI
- Formato de URI
GET https://{Endpoint}/v3.1/{project_id}/flavors?engine_name={engine_name}&engine_version={engine_version}&offset={offset}&limit={limit}
- Exemplo de URI
https://dds.ap-southeast-1.myhuaweicloud.com/v3.1/0549b4a43100d4f32f51c01c2fe4acdb/flavors?engine_name=DDS-Community&engine_version=3.4&offset=1&limit=20
Solicitações
Nome |
Tipo |
IN |
Obrigatório |
Descrição |
---|---|---|---|---|
x-auth-token |
string |
header |
Sim |
Token do usuário |
project_id |
string |
path |
Sim |
Especifica a 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. |
engine_name |
string |
query |
Não |
Especifica o tipo de banco de dados. O valor é DDS-Community. Para obter esse valor, consulte Consulta de informações sobre versão do banco de dados. |
engine_version |
string |
query |
Não |
Número da versão do banco de dados. |
offset |
Integer |
query |
Não |
Deslocamento do índice.
|
limit |
Integer |
query |
Não |
Máximo de informações de especificações que podem ser consultadas
|
Respostas
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
flavors
Array of objects
Sim
Indica a lista de informações de especificações da instância de banco de dados. Para obter mais informações, consulte Tabela 3.
total_count
Integer
Sim
Número total de registros
Tabela 3 Descrição da estrutura de dados do campo flavors Nome
Tipo
Obrigatório
Descrição
engine_name
String
Sim
Indica o nome do motor.
type
String
Sim
Indica o tipo de nó. O DDS contém os seguintes tipos de nós:
- mongos
- shard
- config
- replica
- single
- readonly
vcpus
String
Sim
Indica o número de vCPUs.
ram
String
Sim
Indica o tamanho da memória em gigabyte (GB).
spec_code
String
Sim
Indica o código de especificação do recurso.
Exemplo: dds.mongodb.c6.xlarge.2.shard
NOTA:- dds: indica o serviço DDS.
- dds.mongodb: indica o serviço DDS.
- c6.xlarge.2: indica a especificação do nó. É um tipo de alta memória.
- shard: indica o tipo de nó.
- Ao consultar as especificações, verifique se as especificações são da mesma série. A série de especificações inclui uso geral (s6), aprimorado (c3) e aprimorado II (c6).
az_status
Map<String,String>
Sim
key indica o ID da AZ, value indica o status da especificação na AZ. Seu valor pode ser qualquer um dos seguintes:
- normal: A especificação está à venda.
- unsupported: Esta especificação não é suportada.
- sellout: A especificação está esgotada.
engine_versions
Array of strings
Sim
Versões do banco de dados
Por exemplo, nó DDS mongos, {"3.4", "4.0"}
![](https://support.huaweicloud.com/intl/pt-br/api-dds/public_sys-resources/note_3.0-pt-br.png)
Na resposta de exemplo, az1, az2 e az3 no campo az_status são valores de exemplo.
- Exemplo de resposta
{ "total_count":4, "flavors": [ { "engine_name": "DDS-Community", "type": "mongos", "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.c6.medium.4.mongos", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } }, { "engine_name": "DDS-Community", "type": "shard", "vcpus": "4", "ram": "8", "spec_code": "dds.mongodb.c6.xlarge.2.shard", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } }, { "engine_name": "DDS-Community", "type": "config", "vcpus": "2", "ram": "4", "spec_code": "dds.mongodb.c6.large.2.config", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } }, { "engine_name": "DDS-Community", "type": "replica", "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.c6.medium.4.repset", "engine_versions":["3.4","4.0"], "az_status": { "az1": "normal", "az2": "normal", "az3": "normal" } } ] }
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.