Consulta de todas as especificações de instância
Descrição
Essa API é usada para consultar todas as especificações de instância em uma região especificada.
Depuração
Você pode depurar essa API no API Explorer.
URI
Solicitações
Descrição do parâmetro
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 inquilino em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto. |
region |
string |
query |
Não |
A região onde a instância de banco de dados é implementada. A região onde a instância de banco de dados é implementada. Valor válido: O valor não pode estar vazio. Para obter detalhes sobre como obter esse valor de parâmetro, consulte Regiões e pontos de extremidade. |
engine_name |
string |
query |
Não |
Tipo de banco de dados. O valor é DDS-Community. |
Respostas
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Descrição
flavors
Array of objects
Lista de especificações da instância de banco de dados. Para obter mais informações, consulte Tabela 3.
Tabela 3 Descrição da estrutura de dados do campo flavors Nome
Tipo
Descrição
engine_name
String
Nome do motor
type
String
Tipo de nó. O DDS suporta os seguintes tipos de nós:
- mongos
- shard
- config
- replica
- single
vcpus
String
Quantidade de vCPUs
ram
String
Tamanho da memória em GB
spec_code
String
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
Object
O status das especificações em uma AZ. Seu valor pode ser qualquer um dos seguintes:
- normal: indica que a especificação está à venda.
- unsupported: indica que a especificação não é suportada.
- sellout: indica que a especificação está esgotada.
Na resposta de exemplo, az1, az2 e az3 no campo az_status são valores de exemplo.
- Exemplo de resposta
{ "flavors": [ { "engine_name": "DDS-Community", "type": "mongos", "vcpus": "1", "ram": "4", "spec_code": "dds.mongodb.c6.medium.4.mongos", "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", "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", "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", "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.