Consulta do tipo de disco do banco de dados
Descrição da API
Essa API é usada para consultar o tipo de disco do banco de dados na região atual.
Depuração
Você pode depurar essa API no API Explorer.
URI
Solicitações
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. |
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. |
Respostas
- Descrição do parâmetro
Tabela 2 Descrição do parâmetro Nome
Tipo
Obrigatório
Descrição
storage_type
Array of objects
Sim
Indica a lista de informações do disco do banco de dados. Para obter mais informações, consulte Tabela 3.
dss_pool_info
Array of objects
Sim
Indica a lista de informações de especificações do dss_pool. Para obter mais informações, consulte Tabela 4.
NOTA:Somente usuários de Dedicated Cloud (DeC) são suportados.
Tabela 3 Descrição da estrutura de dados do campo storage_type Nome
Tipo
Obrigatório
Descrição
name
String
Sim
Indica o tipo de armazenamento. Seu valor pode ser:
ULTRAHIGH: indica o tipo de SSD.
EXTREMEHIGH: indica ESSD.
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: indica que as especificações estão à venda.
- unsupported: o tipo de disco não é suportado.
- sellout: indica que as especificações estão esgotadas.
Tabela 4 Descrição da estrutura de dados do campo dss_pool_info Nome
Tipo
Obrigatório
Descrição
az_name
String
Sim
Indica o nome da AZ onde o dss_pool está localizado.
free_capacity_gb
String
Sim
Indica a capacidade disponível do DSS.
Unidade: GB
dss_pool_volume_type
String
Sim
Indica o tipo de disco do pool de armazenamento do DSS.
dss_pool_id
String
Sim
Indica o ID do pool do DSS.
dss_pool_status
String
Sim
Indica o status de dss_pool. Seu valor pode ser qualquer um dos seguintes:
- available
- deploying
- enlarging
- frozen
- sellout
Na resposta de exemplo, az1, az2 e az3 no campo az_status são valores de exemplo.
- Exemplo de resposta
{ "storage_type": [ { "name": "ULTRAHIGH", "az_status": { "az1": "normal", "az2": "normal" } } ], "dss_pool_info": [ { "az_name": "az1xahz", "free_capacity_gb": 150, "dss_pool_volume_type": "ULTRAHIGH", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4df", "dss_pool_status": "available" } ] }
- Exemplo de resposta de consulta do usuário de DeC
{ "storage_type": [ { "name": "ULTRAHIGH", "az_status": { "az1": "normal", "az2": "normal", "az3": "unsupported" } } ], "dss_pool_info": [ { "az_name": "az1", "free_capacity_gb": "8656", "dss_pool_volume_type": "ULTRAHIGH", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "dss_pool_status": "available" } ] }
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.