All Products
Search
Document Center

:DescribeStorageGateway

Last Updated:Nov 18, 2024

Queries storage gateways.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeStorageGatewaylist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnsRegionIdstringNo

The ID of the node.

cn-beijing-cmcc
GatewayIdstringNo

The ID of the gateway.

sgw-****
GatewayTypestringNo

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

1
VpcIdstringNo

The ID of the virtual private cloud (VPC).

n-***
PageNumberstringNo

The page number. Default value: 1.

1
PageSizestringNo

The number of entries per page.

10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Id of the request

6666C5A5-75ED-422E-A022-7121FA18C968
StorageGatewaysarray<object>

The list information.

StorageGatewaysobject

The information about the storage gateway.

EnsRegionIdstring

The ID of the node.

cn-beijing-cmcc
StorageGatewayIdstring

The ID of the storage gateway.

sgw-***
StorageGatewayNamestring

The name of the storage gateway.

testGateway
StorageGatewayTypeinteger

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

1
ServiceIpstring

The IP address of the service.

*.*.*.*
CreationTimestring

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

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

The status of the storage gateway. Valid values:

  • creating
  • available
  • deleting
  • deleted
available
Descriptionstring

The description of the storage gateway.

testDescription
VpcIdstring

The ID of the VPC.

n-***
CidrBlockstring

The internal CIDR block.

192.168.2.0/24
PageNumberinteger

The page number. Default value: 1.

1
PageSizeinteger

The number of entries per page.

Default value: 10.

10
TotalCountinteger

The total number of entries returned.

16

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history