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

Consulta gateways de armazenamento.

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:DescribeStorageGateway

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-beijing-cmcc
GatewayId	string	Não	O ID do gateway.	sgw-****
GatewayType	string	Não	O tipo do gateway. Defina este parâmetro como 1. 1 indica iSCSI.	1
VpcId	string	Não	O ID da virtual private cloud (VPC).	n-***
PageNumber	string	Não	O número da página. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas por página.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema da resposta.
RequestId	string	O ID da solicitação.	6666C5A5-75ED-422E-A022-7121FA18C968
StorageGateways	array<object>	As informações da lista.
	object	As informações sobre o gateway de armazenamento.
EnsRegionId	string	O ID do nó.	cn-beijing-cmcc
StorageGatewayId	string	O ID do gateway de armazenamento.	sgw-***
StorageGatewayName	string	O nome do gateway de armazenamento.	testGateway
StorageGatewayType	integer	O tipo do gateway de armazenamento. Valor padrão: 1, que indica iSCSI.	1
ServiceIp	string	O endereço IP do serviço.	...
CreationTime	string	A hora em que o gateway de armazenamento foi criado. A hora é exibida em UTC.	2024-05-14T03:07:47Z
Status	string	O status do gateway de armazenamento. Valores válidos: creating available deleting deleted	available
Description	string	A descrição do gateway de armazenamento.	testDescription
VpcId	string	O ID da VPC.	n-***
CidrBlock	string	O bloco CIDR interno.	192.168.2.0/24
PageNumber	integer	O número da página. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas retornadas.	16

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "6666C5A5-75ED-422E-A022-7121FA18C968",
  "StorageGateways": [
    {
      "EnsRegionId": "cn-beijing-cmcc\n",
      "StorageGatewayId": "sgw-***",
      "StorageGatewayName": "testGateway",
      "StorageGatewayType": 1,
      "ServiceIp": "*.*.*.*",
      "CreationTime": "2024-05-14T03:07:47Z",
      "Status": "available",
      "Description": "testDescription",
      "VpcId": "n-***",
      "CidrBlock": "192.168.2.0/24"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 16
}

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.