Consulta de cotas de recursos
Descrição
Essa API é usada para consultar as cotas de recursos do DDS de um locatário, incluindo a cota de instância de cluster, a cota de instância de nó único e a cota de instância de conjunto de réplicas.
Depuração
Você pode depurar essa API no API Explorer.
URI
|
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 locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto. |
Solicitações
Nenhuma
Respostas
- Descrição do parâmetro
Tabela 2 Parâmetros de corpo da resposta Parâmetro
Tipo
Obrigatório
Descrição
quotas
Object
Sim
Informações sobre cotas.
Para obter mais informações, consulte Tabela 3.
Tabela 3 ShowResourcesListResponseBody Parâmetro
Tipo
Obrigatório
Descrição
resources
Objects
Sim
Os objetos de recurso.
Para obter mais informações, consulte Tabela 4.
Tabela 4 ShowResourcesDetailResponseBody Parâmetro
Tipo
Obrigatório
Descrição
type
String
Sim
O tipo de recurso de cota. Somente o tipo de instância é suportado.
mode
String
Sim
O tipo de instância.
- Se o valor for Single, as informações de cota de uma única instância de nó serão exibidas.
- Se o valor for ReplicaSet, as informações de cota de uma instância do conjunto de réplicas serão exibidas.
- Se o valor for Sharding, as informações de cota de uma instância de cluster serão exibidas.
quota
Integer
Sim
A quota existente.
used
Integer
Sim
O número de instâncias usadas.
- Exemplo de resposta
{
"quotas" : {
"resources" : [ {
"type" : "instance",
"mode" : "Sharding",
"quota" : 80,
"used" : 6
}, {
"type" : "instance",
"mode" : "ReplicaSet",
"quota" : 80,
"used" : 9
}, {
"type" : "instance",
"mode" : "Single",
"quota" : 1000,
"used" : 5
} ]
}
}
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.
