Obtenção de detalhes de pools de armazenamento do DSS
Função
Essa API é usada para obter os pools de armazenamento do solicitados por um locatário. Consulta de filtro e consulta de paginação são suportadas.
URI
GET /v1/{project_id}/pools/detail
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
O ID do projeto. Para saber como obter o ID do projeto, consulte Obtenção de um ID de projeto. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
limit |
Não |
Integer |
O número máximo de resultados de consulta que podem ser retornados. O valor deve ser um número inteiro maior que 0. |
offset |
Não |
Integer |
Posição inicial de uma consulta de paginação. O valor deve ser um número inteiro positivo ou 0.
NOTA:
Esse parâmetro indica que todos os pools de armazenamento após esse deslocamento de consulta de paginação são consultados. |
status |
Não |
String |
O status do pool de armazenamento. O valor pode ser available, deploying ou extending. Para mais detalhes, consulte Status do pool de armazenamento do DSS. |
name |
Não |
String |
O nome do pool de armazenamento. |
usage |
Não |
Boolean |
Se as informações de capacidade do pool de armazenamento são retornadas. O valor pode ser true ou false. O valor true indica para retornar as informações de capacidade. O valor padrão é false. |
Solicitação
Exemplos de solicitações
GET https://{endpoint}/v1/{project_id}/pools/detail?status=available&usage=true
Resposta
Parâmetros de resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
pools |
Array of objects |
Os detalhes do pool de armazenamento. Para mais detalhes, consulte Tabela 4. |
count |
Integer |
O número de pools de armazenamento. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
name |
String |
O nome do pool de armazenamento. |
id |
String |
O ID do pool de armazenamento. |
project_id |
String |
O ID do projeto ao qual o pool pertence. |
capacity |
Integer |
A capacidade do pool de armazenamento solicitado, em TB. |
type |
String |
O tipo de pool de armazenamento. O valor pode ser o seguinte:
|
status |
String |
O status do pool de armazenamento. Para mais detalhes, consulte Status do pool de armazenamento do DSS. |
availability_zone |
String |
A AZ onde o pool de armazenamento reside. |
created_at |
String |
A hora em que o pool de armazenamento foi criado. Formato da hora: UTC YYYY-MM-DDTHH:MM:SS |
total_capacity_gb |
Integer |
A capacidade total do pool de armazenamento, em GB. (Esse parâmetro não será retornado se o status do pool de armazenamento for deploying.) |
used_capacity_gb |
Integer |
A capacidade usada do pool de armazenamento, em GB. (Esse parâmetro não será retornado se o status do pool de armazenamento for deploying.) |
provisioned_capacity_gb |
Integer |
A capacidade alocada do pool de armazenamento, em GB. (Esse parâmetro não será retornado se o status do pool de armazenamento for deploying.) |
max_over_subscription_ratio |
Float |
A taxa de comprometimento excessivo do pool de armazenamento. (Esse parâmetro não será retornado se o status do pool de armazenamento for deploying.) |
- Exemplo de resposta
{ "pools" : [ { "name" : "dedicatedStorage01", "id" : "c950ee97-587c-4f24-8a74-3367e3da570f", "project_id" : "63d910f2705a487ebe4e1c274748d9e1", "capacity" : 1000, "type" : "SSD", "availability_zone" : "AZ1", "status" : "available", "created_at" : "2014-12-18T15:57:56.299000", "total_capacity_gb": 850, "used_capacity_gb": 300, "provisioned_capacity_gb":700, "max_over_subscription_ratio": 1.0 }, { "name" : "dedicatedStorage02", "id" : "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", "project_id" : "63d910f2705a487ebe4e1c274748d9e1", "capacity" : 1000, "type" : "SSD", "availability_zone" : "AZ1", "status" : "available", "created_at" : "2014-12-18T15:57:56.299000", "total_capacity_gb": 850, "used_capacity_gb": 300, "provisioned_capacity_gb":700, "max_over_subscription_ratio": 1.0 } ] , "count": 2 }
- Resposta de erro
{ "error": { "message": "invalid filter limit!", "code": "DSS.1003" } }
Valores retornados
- Normal
- Anormal
Consulte Descrição do código de erro.
Códigos de erro
Consulte Códigos de erro.