DescribeStorageVolume - ENS: Central de Documentação do Alibaba Cloud

Consulta volumes.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ens:DescribeStorageVolume

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EnsRegionId	string	Não	O ID do nó.	cn-shenzhen-3
VolumeId	string	Não	O ID do volume.	sv-***
GatewayId	string	Não	O ID do gateway.	sgw-****
StorageId	string	Não	O ID do meio de armazenamento.	d-***
IsEnable	integer	Não	Especifica se o volume deve ser ativado. Valores válidos: 1 (padrão): ativa o volume. 0: desativa o volume.	1
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
StorageVolumes	array<object>	A lista de resultados retornados.
	object	As informações sobre o volume.
StorageVolumeId	string	O ID do volume.	sv-***
StorageVolumeName	string	O nome do volume.	testVolumeName
StorageGatewayId	string	O ID do gateway de armazenamento.	sgw-***
StorageId	string	O ID do meio de armazenamento.	d-***
CreationTime	string	A hora em que o volume foi criado. A hora é exibida em UTC.	2024-03-14T09:35:32Z
IsEnable	integer	Indica se o volume está ativado. Valores válidos: 1 (padrão): o volume está ativado. 0: o volume está desativado.	1
IsAuth	integer	Indica se a autenticação está ativada. Valores válidos: 1: a autenticação está ativada. 0 (padrão): a autenticação está desativada.	0
Description	string	A descrição do volume.	testDescription
TargetName	string	O destino do volume.	iqn...:
Status	string	O status do volume. Valores válidos: creating available deleting deleted	available
AuthProtocol	string	O protocolo de autenticação. O valor é definido como CHAP.	CHAP
EnsRegionId	string	O ID do nó.	cn-shenzhen-3
RequestId	string	O ID da solicitação.	AAE90880-4970-4D81-A534-A6C0F3631F74
PageNumber	string	O número da página. Valor padrão: 1.	1
PageSize	string	O número de entradas por página.	10
TotalCount	string	O número total de entradas retornadas.	15

Exemplos

Resposta de sucesso

JSON formato

{
  "StorageVolumes": [
    {
      "StorageVolumeId": "sv-***",
      "StorageVolumeName": "testVolumeName",
      "StorageGatewayId": "sgw-***",
      "StorageId": "d-***",
      "CreationTime": "2024-03-14T09:35:32Z",
      "IsEnable": 1,
      "IsAuth": 0,
      "Description": "testDescription",
      "TargetName": "iqn.*.*.*:*",
      "Status": "available",
      "AuthProtocol": "CHAP",
      "EnsRegionId": "cn-shenzhen-3"
    }
  ],
  "RequestId": "AAE90880-4970-4D81-A534-A6C0F3631F74",
  "PageNumber": "1",
  "PageSize": "10",
  "TotalCount": "15"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.