All Products
Search

This Product

    ENS:DescribeStorageGateway

    Document Center

    ENS:DescribeStorageGateway

    Last Updated:Mar 27, 2026

    Queries storage gateways.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ens:DescribeStorageGateway

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    EnsRegionId

    string

    No

    The ID of the node.

    cn-beijing-cmcc
    GatewayId

    string

    No

    The ID of the gateway.

    sgw-****
    GatewayType

    string

    No

    The type of the gateway. Set this parameter to 1. 1 indicates iSCSI.

    1
    VpcId

    string

    No

    The ID of the virtual private cloud (VPC).

    n-***
    PageNumber

    string

    No

    The page number. Default value: 1.

    1
    PageSize

    string

    No

    The number of entries per page.

    10

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    6666C5A5-75ED-422E-A022-7121FA18C968
    StorageGateways

    array<object>

    The list information.

    object

    The information about the storage gateway.

    EnsRegionId

    string

    The ID of the node.

    cn-beijing-cmcc

    StorageGatewayId

    string

    The ID of the storage gateway.

    sgw-***
    StorageGatewayName

    string

    The name of the storage gateway.

    testGateway
    StorageGatewayType

    integer

    The type of the storage gateway. Default value: 1, which indicates iSCSI.

    1
    ServiceIp

    string

    The IP address of the service.

    *.*.*.*
    CreationTime

    string

    The time when the storage gateway was created. The time is displayed in UTC.

    2024-05-14T03:07:47Z
    Status

    string

    The status of the storage gateway. Valid values:

    • creating

    • available

    • deleting

    • deleted

    available
    Description

    string

    The description of the storage gateway.

    testDescription
    VpcId

    string

    The ID of the VPC.

    n-***
    CidrBlock

    string

    The internal CIDR block.

    192.168.2.0/24
    PageNumber

    integer

    The page number. Default value: 1.

    1
    PageSize

    integer

    The number of entries per page.

    Default value: 10.

    10
    TotalCount

    integer

    The total number of entries returned.

    16

    Examples

    Success response

    JSON format

    {
  "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
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.