DescribeGateway-阿里云帮助中心

Queries the basic information of a specified gateway, including details such as the gateway status and type.

Operation description

Take note of the following items when you call this operation:

Make sure that you fully understand the billing methods and pricing of Cloud Storage Gateway before calling this operation.
If you need to purchase a gateway, you can use the purchase URL or renewal URL returned by this operation to purchase or renew the gateway.

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

hcs-sgw:DescribeGateway

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The gateway ID.	gw-000eg44nmxbsfwbvq***

Response elements

Element	Type	Description	Example
	object	The query result of the basic gateway information.
Description	string	The description of the gateway.	For testing
CreatedTime	integer	The time when the gateway was created. The timestamp is in seconds.	1532099461
PublicNetworkBandwidth	integer	The Internet bandwidth for data, in Mbit/s. This parameter is returned if the gateway is a cloud gateway.	5
DataLoadType	string	[Deprecated]	Deprecated
Category	string	The category of the gateway. Default value: `Aliyun`.	Aliyun
TaskId	string	The task ID.	t-0000iwdggbharrw6r***
Message	string	The description of the request result.	successful
ExpireStatus	integer	The expiration status of the subscription gateway. Valid values: 0: normal 1: expiring 2: expired	0
Ip	string	The public IP address.	47.101..
GatewayType	string	The type of the gateway. Valid values: File: file gateway Iscsi: block gateway	File
StorageBundleId	string	The ID of the gateway cluster.	sb-000dt67z4ijqfocpy***
GatewayClass	string	The specifications of the gateway. This parameter is returned only if the gateway is a cloud gateway. Valid values: Basic: basic Standard: standard Enhanced: enhanced Advanced: advanced	Basic
Success	boolean	Indicates whether the request is successful. Valid values: true: yes false: no	true
Name	string	The name of the gateway.	alex***
IsPostPaid	boolean	Indicates whether the gateway is a pay-as-you-go gateway. Valid values: true: The gateway is a pay-as-you-go gateway. false: The gateway is a subscription gateway.	true
Capacity	integer	[Deprecated]	500
ExpiredTime	integer	The expiration time of the subscription gateway. The timestamp is in milliseconds.	1532530021
GatewayVersion	string	The version of the gateway.	1.0.39
IsReleaseAfterExpiration	boolean	Indicates whether an upfront gateway is released upon expiration. Valid values: true: The gateway is automatically released and directly accepted. false: The billing method of the upfront gateway is automatically changed to the pay-as-you-go pattern upon expiration.	false
Status	string	The status of the gateway. Valid values: Initialized: initialized Deactivated: deactivated Activated: activated Deploying: deploying Running: running Stopping: stopping Stopped: stopped Starting: starting Rebooting: rebooting Deleting: deleting Failed: failed Upgrading: upgrading Modifying: modifying Unknown: no heartbeat received for a long time	Initialized
BuyURL	string	The purchase and payment URL for the subscription gateway when the payment is incomplete.	https://expense.console.aliyun.com/?returnExpense=true#/order/list/
MaxThroughput	integer	[Deprecated]	30
DataLoadInterval	integer	[Deprecated]	120
InnerIp	string	The mount IP address.	172.19.55.65
RequestId	string	The request ID.	736C7733-FCED-4AFB-8407-C325F210CE03
VSwitchId	string	The vSwitch ID.	vsw-bp1b3mvml55ziekq7e***
ElasticNodes	object
ElasticNode	array	The IP address information of the elastic gateway node.
	string	[Deprecated]	172.16.0.23
GatewayId	string	The gateway ID.	gw-0000ewknguw5o96vn***
Code	string	The status code. A status code of 200 indicates that the request is successful.	200
EcsInstanceId	string	The ECS instance ID.	i-uf62406gy5vyao4y8***
Type	string	See the GatewayType parameter.	File
RenewURL	string	The renewal URL for the subscription gateway.	https://common-buy.aliyun.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew
VpcId	string	The VPC ID.	vpc-uf6j237kxmsw08auey***
ActivatedTime	integer	The time when the gateway was activated. The timestamp is in seconds.	1578986214
ElasticGateway	boolean	[Deprecated]	false
CommonBuyInstanceId	string	The instance ID of the subscription gateway in the sales system.	gw-000fhosecoziy6ri****
InnerIpv6Ip	string	The IPv6 address.	2408:4004::ffff:ffff:ffff:ffff:ffff:ffff
LastErrorKey	string	The error keyword.	InternalError
Location	string	The location of the gateway. Valid values: Cloud: cloud gateway On_Premise: on-premises gateway	Cloud
GatewayRegionId	string	The region of the gateway.	cn-hangzhou
UntrustedEnvInstanceType	string	The actual specifications of the gateway in untrusted (Cloud Box) scenarios.	ecs.g6.large
UntrustedEnvOssEndpoint	string	The OSS endpoint of the gateway in untrusted (Cloud Box) scenarios.	oss-cn-hangzhou.aliyuncs.com
HighAvailability	boolean	Indicates whether the gateway is a high-availability gateway.	false
SecondaryVSwitchId	string	The vSwitch ID of the secondary node for the high-availability gateway.	vsw-bp1xw499jo5****

Examples

Success response

JSON format

{
  "Description": "For testing",
  "CreatedTime": 1532099461,
  "PublicNetworkBandwidth": 5,
  "DataLoadType": "Deprecated.",
  "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****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyGatewayId	You must enter a valid ID for the gateway.	You must enter a valid ID for the gateway.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.