DescribeStorageGateway - ENS - Centro de documentación de Alibaba Cloud

Consulta las puertas de enlace de almacenamiento.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ens:DescribeStorageGateway

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
EnsRegionId	string	No	El ID del nodo.	cn-beijing-cmcc
GatewayId	string	No	El ID de la puerta de enlace.	sgw-****
GatewayType	string	No	El tipo de puerta de enlace. Establezca este parámetro en 1. 1 indica iSCSI.	1
VpcId	string	No	El ID de la nube privada virtual (VPC).	n-***
PageNumber	string	No	El número de página. Valor predeterminado: 1.	1
PageSize	string	No	El número de entradas por página.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	6666C5A5-75ED-422E-A022-7121FA18C968
StorageGateways	array<object>	La información de la lista.
	object	La información sobre la puerta de enlace de almacenamiento.
EnsRegionId	string	El ID del nodo.	cn-beijing-cmcc
StorageGatewayId	string	El ID de la puerta de enlace de almacenamiento.	sgw-***
StorageGatewayName	string	El nombre de la puerta de enlace de almacenamiento.	testGateway
StorageGatewayType	integer	El tipo de puerta de enlace de almacenamiento. Valor predeterminado: 1, que indica iSCSI.	1
ServiceIp	string	La dirección IP del servicio.	...
CreationTime	string	La hora en que se creó la puerta de enlace de almacenamiento. La hora se muestra en formato UTC.	2024-05-14T03:07:47Z
Status	string	El estado de la puerta de enlace de almacenamiento. Valores válidos: creating available deleting deleted	available
Description	string	La descripción de la puerta de enlace de almacenamiento.	testDescription
VpcId	string	El ID de la VPC.	n-***
CidrBlock	string	El bloque CIDR interno.	192.168.2.0/24
PageNumber	integer	El número de página. Valor predeterminado: 1.	1
PageSize	integer	El número de entradas por página. Valor predeterminado: 10.	10
TotalCount	integer	El número total de entradas devueltas.	16

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.