DescribeStorageGateway - 查询存储网关 - 边缘节点服务ENS

查询存储网关

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeStorageGateway

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
EnsRegionId	string	否	节点 ID。	cn-beijing-cmcc
GatewayId	string	否	网关 ID。	sgw-****
GatewayType	string	否	网关类型。当前仅支持取值为 1，1 代表 iSCSI。	1
VpcId	string	否	专有网络 ID。	n-***
PageNumber	string	否	列表的页码，默认值为 1。	1
PageSize	string	否	分页查询时设置的每页行数。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	6666C5A5-75ED-422E-A022-7121FA18C968
StorageGateways	array<object>	列表信息。
	object	存储网关信息。
EnsRegionId	string	节点 ID。	cn-beijing-cmcc
StorageGatewayId	string	存储网关 ID。	sgw-***
StorageGatewayName	string	存储网关名称。	testGateway
StorageGatewayType	integer	存储网关类型。默认 1，iscsi。	1
ServiceIp	string	服务 IP。	...
CreationTime	string	创建时间。UTC 时间	2024-05-14T03:07:47Z
Status	string	存储网关状态。取值： creating：创建中。 available：可用。 deleting：删除中。 deleted：已删除。	available
Description	string	描述信息。	testDescription
VpcId	string	专有网络 ID。	n-***
CidrBlock	string	内网网段。	192.168.2.0/24
PageNumber	integer	列表的页码，默认值为 1。	1
PageSize	integer	分页查询时设置的每页行数。默认值：10。	10
TotalCount	integer	列表条目数。	16

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。