AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云存储网关 开发参考 API参考指南 API目录 网关 DescribeGateways - 查询网关列表信息

DescribeGateways - 查询网关列表信息

更新时间：
产品详情
我的收藏

查询网关列表信息。包括网关ID，网关名称等。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGateways

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
StorageBundleId

string

否

网关集群 ID。

说明

  • 如果不指定 ResourceRegionId，则必须指定该参数。

sb-0001b2otnkdxrigeq***
PageNumber

integer

否

网关列表信息的页码。

  • 起始值：1。

  • 默认值：1。

1
PageSize

integer

否

分页查询时设置的每页行数。

  • 最大值：50。

  • 默认值：10。

10
ResourceRegionId

string

否

资源所属的地域 ID。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

指定网关集群 ID 下的网关总数。

2
RequestId

string

请求 ID。

2C4A8287-66F4-45F9-84E3-866E4232C763
Message

string

请求结果描述。

successful
PageSize

integer

网关列表每页的行数。

10
PageNumber

integer

网关列表信息的页码。

1
Gateways

object

Gateway

array<object>

网关列表信息。

object

网关信息。

VpcId

string

专有网络 VPC ID。

vpc-bp1p0usrgr5z9e7lwr***
Status

string

网关状态。可能值：

  • Initialized：已初始化。

  • Deactivated：未激活。

  • Activated：已激活。

  • Deploying：部署中。

  • Running：运行中。

  • Stopping：停止中。

  • Stopped：已停止。

  • Starting：启动中。

  • Rebooting：重启中。

  • Deleting：删除中。

  • Failed：失败。

  • Upgrading：升级中。

  • Modifying：修改中。

  • Unknown：长时间没有心跳。

Running
Type

string

参见 GatewayType 参数

File
Capacity

integer

废弃。

500
GatewayId

string

网关 ID。

gw-0001b2odzvl3b1mhi***
IsReleaseAfterExpiration

boolean

当付费类型为包年包月时，网关是否到期释放。可能值：

  • true：到期释放，直接收回。创建的云存储网关到期 7 天后，停止云存储网关服务。

  • false：创建的云存储网关到期后，转按量付费模式。

false
GatewayType

string

网关类型

  • File：文件网关

  • Iscsi：块网关

File
BuyURL

string

付费类型为包年包月时，返回购买链接。

https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={"gateway_id":"gw-0007va9bnidei3s8a***”,”directBuy":"false","gateway_class":"standard","cache_cloud_efficiency_size":0}&regionId=cn-hangzhou#/buy
EcsInstanceId

string

ECS 实例 ID。

gw-0001b2onkdzvl3b***
MaxThroughput

integer

废弃。

30。
GatewayClass

string

网关规格。可能值：

  • Basic：基础型。

  • Standard：标准型。

  • Enhanced：增强型。

  • Advanced：性能型。

Advanced
InnerIp

string

挂载 IP。

172.16.0.21
Description

string

网关描述。

测试使用
Name

string

网关名称。

fio-weekly***
InnerIpv6Ip

string

IPv6 地址。

2408:4004:110:6000:4656:f88e:1c14:e578
CreatedTime

integer

网关创建时间。时间戳为秒（s）。

1577179604
ExpireStatus

integer

网关是否过期状态。可能值：

  • 0：正常。

  • 1：将要过期。

  • 2：已经过期。

0
DataLoadInterval

integer

废弃。

120
RenewURL

string

续费链接。

https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew
IsPostPaid

boolean

付费类型。可能值：

  • true：按量付费，即后付费。

  • false：包年包月，即预付费。

true
PublicNetworkBandwidth

integer

数据公网带宽，单位为 Mbps。仅线上网关支持。

55
StorageBundleId

string

网关集群 ID。

sb-0001b2otrigeqkso***
Ip

string

公网 IP。

47.111.145.66
LastErrorKey

string

错误关键字。

InternalError
ElasticNodes

object

ElasticNode

array

废弃。

string

废弃。

172.16.0.23
VSwitchId

string

虚拟交换机 vSwitch ID。

vsw-bp1krhkgnahkb9stp0***
CommonBuyInstanceId

string

付费类型为包年包月时，在售卖系统中的实例 ID。

gw-0001b2onkdzvl3b***
ExpiredTime

integer

到期时间。时间戳为秒（s）。

1532426471
GatewayVersion

string

网关版本。

1.2.6
DataLoadType

string

废弃。

once
ElasticGateway

boolean

废弃。

false
Category

string

网关类别。

  • 默认：Aliyun。

Aliyun
ActivatedTime

integer

激活时间。时间戳为秒（s）。

1577179769
TaskId

string

任务 ID。

t-000978oflgrd8ah6p***
Location

string

网关位置。可能值：

  • Cloud：线上网关。

  • On_Premise：线下网关。

Cloud
GatewayRegionId

string

网关地域。

cn-hangzhou
UntrustedEnvInstanceType

string

非授信（云盒）场景下网关的实际规格。

ecs.g6.large
HighAvailability

boolean

是否为跨可用区高可用网关，返回值如下：

  • true：是跨可用区高可用网关。

  • false：不是跨可用区高可用网关。

false
SecondaryVSwitchId

string

虚拟交换机 vSwitch ID。仅高可用网关支持。

vsw-bp1krhkgnahkb8stp0***
Code

string

状态码。状态码为 200 表示请求成功。

200
Success

boolean

请求是否成功。

true

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "2C4A8287-66F4-45F9-84E3-866E4232C763",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "Gateways": {
    "Gateway": [
      {
        "VpcId": "vpc-bp1p0usrgr5z9e7lwr***",
        "Status": "Running",
        "Type": "File",
        "Capacity": 500,
        "GatewayId": "gw-0001b2odzvl3b1mhi***",
        "IsReleaseAfterExpiration": false,
        "GatewayType": "File",
        "BuyURL": "https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&request={\"gateway_id\":\"gw-0007va9bnidei3s8a***”,”directBuy\":\"false\",\"gateway_class\":\"standard\",\"cache_cloud_efficiency_size\":0}&regionId=cn-hangzhou#/buy",
        "EcsInstanceId": "gw-0001b2onkdzvl3b***",
        "MaxThroughput": 0,
        "GatewayClass": "Advanced",
        "InnerIp": "172.16.0.21",
        "Description": "测试使用",
        "Name": "fio-weekly***",
        "InnerIpv6Ip": "2408:4004:110:6000:4656:f88e:1c14:e578",
        "CreatedTime": 1577179604,
        "ExpireStatus": 0,
        "DataLoadInterval": 120,
        "RenewURL": "https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndnu72#/renew",
        "IsPostPaid": true,
        "PublicNetworkBandwidth": 55,
        "StorageBundleId": "sb-0001b2otrigeqkso***",
        "Ip": "47.111.145.66",
        "LastErrorKey": "InternalError",
        "ElasticNodes": {
          "ElasticNode": [
            "172.16.0.23"
          ]
        },
        "VSwitchId": "vsw-bp1krhkgnahkb9stp0***",
        "CommonBuyInstanceId": "gw-0001b2onkdzvl3b***",
        "ExpiredTime": 1532426471,
        "GatewayVersion": "1.2.6",
        "DataLoadType": "once",
        "ElasticGateway": false,
        "Category": "Aliyun",
        "ActivatedTime": 1577179769,
        "TaskId": "t-000978oflgrd8ah6p***",
        "Location": "Cloud",
        "GatewayRegionId": "cn-hangzhou",
        "UntrustedEnvInstanceType": "ecs.g6.large",
        "HighAvailability": false,
        "SecondaryVSwitchId": "vsw-bp1krhkgnahkb8stp0***"
      }
    ]
  },
  "Code": "200",
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述
400 EmptyStorageBundleId You must enter a valid ID for the gateway cluster. 网关集群ID不能为空。
400 BadPageSize The specified number of pages is invalid. The number ranges from 1 to 50. 无效的页数，取值范围：1~50。
400 BadPageNumber The specified page number is invalid. The page number must be greater than 0. 无效的页码，不能小于0。
404 StorageBundleNotExist The name you specified for the gateway cluster does not exist. You must specify a valid parameter. 网关集群不存在，请确认输入参数是否正确。

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

变更历史

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

上一篇：DescribeTasks - 查询任务信息下一篇：DescribeGatewayCategories - 查询网关类别