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

DescribeGateway - 查询网关基本信息

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

根据指定网关ID查询网关的基本信息。包括网关状态、类型等详情。

接口说明

接口说明

调用该接口时，您需要注意：

  • 请确保在使用该接口前，已充分了解云存储网关产品的收费方式和价格。

  • 如果您需要购买网关，您可以通过该接口返回的购买链接或续费链接进行购买或续费。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DescribeGateway

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
GatewayId

string

是

网关 ID。

gw-000eg44nmxbsfwbvq***

返回参数

名称

类型

描述

示例值

object

Description

string

网关描述。

测试使用
CreatedTime

integer

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

1532099461
PublicNetworkBandwidth

integer

数据公网带宽，单位为 Mbps。如果网关为线上网关返回数据公网带宽。

5
DataLoadType

string

废弃。

废弃
Category

string

网关类别。默认值为Aliyun。

Aliyun
TaskId

string

任务 ID。

t-0000iwdggbharrw6r***
Message

string

请求结果描述。

successful
ExpireStatus

integer

预付费情况下，网关是否过期的状态。可能值：

  • 0：正常

  • 1：将要过期

  • 2：已经过期

0
Ip

string

公网 IP。

47.101.**.**
GatewayType

string

网关类型，可能值如下：

  • File：文件网关

  • Iscsi：块网关

File
StorageBundleId

string

网关集群 ID。

sb-000dt67z4ijqfocpy***
GatewayClass

string

网关规格。当网关为线上网关时会返回网关规格。可能值如下：

  • Basic：基础型

  • Standard：标准型

  • Enhanced：增强型

  • Advanced：性能型

Basic
Success

boolean

请求是否成功。可能值如下：

  • true：是

  • false：否

true
Name

string

网关名称。

alex***
IsPostPaid

boolean

是否为后付费网关。可能值如下：

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

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

true
Capacity

integer

废弃。

500
ExpiredTime

integer

预付费情况下，网关的过期时间，时间戳为毫秒（ms）。

1532530021
GatewayVersion

string

网关版本。

1.0.39
IsReleaseAfterExpiration

boolean

预付费情况下，是否到期释放。可能值如下：

  • true：到期自动释放，直接收回。

  • false：预付费到期后自动转为按量付费模式。

false
Status

string

网关状态。可能值如下：

  • Initialized：已初始化

  • Deactivated：未激活

  • Activated：已激活

  • Deploying：部署中

  • Running：运行中

  • Stopping：停止中

  • Stopped：已停止

  • Starting：启动中

  • Rebooting：重启中

  • Deleting：删除中

  • Failed：失败

  • Upgrading：升级中

  • Modifying：修改中

  • Unknown：长时间没有心跳

Initialized
BuyURL

string

未完成支付情况下，预付费的购买支付链接。

https://expense.console.aliyun.com/?returnExpense=true#/order/list/
MaxThroughput

integer

废弃。

30
DataLoadInterval

integer

废弃。

120
InnerIp

string

挂载 IP。

172.19.55.65
RequestId

string

请求 ID。

736C7733-FCED-4AFB-8407-C325F210CE03
VSwitchId

string

虚拟交换机 vSwitch ID。

vsw-bp1b3mvml55ziekq7e***
ElasticNodes

object

ElasticNode

array

弹性网关节点 IP 信息。

string

废弃。

172.16.0.23
GatewayId

string

网关 ID。

gw-0000ewknguw5o96vn***
Code

string

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

200
EcsInstanceId

string

ECS 实例 ID。

i-uf62406gy5vyao4y8***
Type

string

参见 GatewayType 参数。

File
RenewURL

string

预付费情况下的续费链接。

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

string

专有网络 VPC ID。

vpc-uf6j237kxmsw08auey***
ActivatedTime

integer

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

1578986214
ElasticGateway

boolean

废弃。

false
CommonBuyInstanceId

string

包年包月网关在售卖系统中的实例 ID。

gw-000fhosecoziy6ri****
InnerIpv6Ip

string

IPv6 地址。

2408:4004::ffff:ffff:ffff:ffff:ffff:ffff
LastErrorKey

string

错误关键字。

InternalError
Location

string

网关位置。可能值如下：

  • Cloud：线上网关

  • On_Premise：线下网关

Cloud
GatewayRegionId

string

网关地域。

cn-hangzhou
UntrustedEnvInstanceType

string

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

ecs.g6.large
UntrustedEnvOssEndpoint

string

非授信（云盒）场景下网关的 OSS Endpoint。

oss-cn-hangzhou.aliyuncs.com
HighAvailability

boolean

是否为高可用网关。

false
SecondaryVSwitchId

string

高可用网关备节点虚拟交换机 ID。

vsw-bp1xw499jo5****

示例

正常返回示例

JSON格式

{
  "Description": "测试使用",
  "CreatedTime": 1532099461,
  "PublicNetworkBandwidth": 5,
  "DataLoadType": "  废弃",
  "Category": "Aliyun",
  "TaskId": "t-0000iwdggbharrw6r***",
  "Message": "successful",
  "ExpireStatus": 0,
  "Ip": "47.101.**.**",
  "GatewayType": "File",
  "StorageBundleId": "sb-000dt67z4ijqfocpy***",
  "GatewayClass": "Basic",
  "Success": true,
  "Name": "alex***",
  "IsPostPaid": true,
  "Capacity": 500,
  "ExpiredTime": 1532530021,
  "GatewayVersion": "1.0.39",
  "IsReleaseAfterExpiration": false,
  "Status": "Initialized",
  "BuyURL": "https://expense.console.aliyun.com/?returnExpense=true#/order/list/",
  "MaxThroughput": 30,
  "DataLoadInterval": 120,
  "InnerIp": "172.19.55.65",
  "RequestId": "736C7733-FCED-4AFB-8407-C325F210CE03",
  "VSwitchId": "vsw-bp1b3mvml55ziekq7e***",
  "ElasticNodes": {
    "ElasticNode": [
      "172.16.0.23"
    ]
  },
  "GatewayId": "gw-0000ewknguw5o96vn***",
  "Code": "200",
  "EcsInstanceId": "i-uf62406gy5vyao4y8***",
  "Type": "File",
  "RenewURL": "https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew",
  "VpcId": "vpc-uf6j237kxmsw08auey***",
  "ActivatedTime": 1578986214,
  "ElasticGateway": false,
  "CommonBuyInstanceId": "gw-000fhosecoziy6ri****",
  "InnerIpv6Ip": "2408:4004::ffff:ffff:ffff:ffff:ffff:ffff",
  "LastErrorKey": "InternalError",
  "Location": "Cloud",
  "GatewayRegionId": "cn-hangzhou",
  "UntrustedEnvInstanceType": "ecs.g6.large",
  "UntrustedEnvOssEndpoint": "oss-cn-hangzhou.aliyuncs.com",
  "HighAvailability": false,
  "SecondaryVSwitchId": "vsw-bp1xw499jo5****"
}

错误码

HTTP status code

错误码

错误信息

描述
400 EmptyGatewayId You must enter a valid ID for the gateway. 网关ID不能为空。
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. 网关不存在，请确认输入参数是否正确。

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

变更历史

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

上一篇：DeleteGateway - 删除网关下一篇：ModifyGateway - 修改网关基本信息