All Products
Search

This Product

    Cloud Storage Gateway:DescribeGateway

    Document Center

    Cloud Storage Gateway:DescribeGateway

    Last Updated:Aug 04, 2025

    Queries basic information about a gateway, such as its status and type, based on the specified gateway ID.

    Operation description

    Description

    Before you call this operation, note the following:

    • Make sure that you understand the billing methods and pricing of Cloud Storage 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 support 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 None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    GatewayId

    string

    Yes

    The gateway ID.

    gw-000eg44nmxbsfwbvq***

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    Description

    string

    The description of the gateway.

    CreatedTime

    integer

    The time when the gateway was created. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1532099461
    PublicNetworkBandwidth

    integer

    The public bandwidth. Unit: Mbit/s. If the gateway is a cloud gateway, the public bandwidth is returned.

    50
    DataLoadType

    string

    This parameter is discontinued.

    once
    Category

    string

    The category of the gateway. The default value is Aliyun.

    Aliyun
    TaskId

    string

    The task ID.

    t-0000iwdggbharrw6r***
    Message

    string

    The description of the result.

    successful
    ExpireStatus

    integer

    The expiration status of the subscription gateway. Valid values:

    • 0: The gateway is normal.

    • 1: The gateway is about to expire.

    • 2: The gateway has expired.

    0
    Ip

    string

    The public IP address.

    47.101.160.44
    GatewayType

    string

    The type of the gateway. Valid values:

    • File: file gateway

    • Iscsi: iSCSI gateway

    File
    StorageBundleId

    string

    The ID of the gateway cluster.

    sb-000dt67z4ijqfocpy***
    GatewayClass

    string

    The gateway class. This parameter is returned if the gateway is a cloud gateway. Valid values:

    • Basic: Basic

    • Standard: Standard

    • Enhanced: Enhanced

    • Advanced: Performance

    Basic
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    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

    This parameter is discontinued.

    500
    ExpiredTime

    integer

    The time when the subscription gateway expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1532530021
    GatewayVersion

    string

    The version of the gateway.

    1.0.39
    IsReleaseAfterExpiration

    boolean

    Indicates whether the subscription gateway is automatically released after it expires. Valid values:

    • true: The gateway is automatically released after it expires.

    • false: The gateway is automatically converted to a pay-as-you-go gateway after it expires.

    false
    Status

    string

    The status of the gateway. Valid values:

    • Initialized: The gateway is initialized.

    • Deactivated: The gateway is inactive.

    • Activated: The gateway is active.

    • Deploying: The gateway is being deployed.

    • Running: The gateway is running.

    • Stopping: The gateway is being stopped.

    • Stopped: The gateway is stopped.

    • Starting: The gateway is being started.

    • Rebooting: The gateway is being restarted.

    • Deleting: The gateway is being deleted.

    • Failed: The gateway failed.

    • Upgrading: The gateway is being upgraded.

    • Modifying: The gateway is being modified.

    • Unknown: The gateway has no heartbeat for a long time.

    Initialized
    BuyURL

    string

    The purchase URL of the subscription gateway if the payment is not complete.

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

    integer

    This parameter is discontinued.

    30
    DataLoadInterval

    integer

    This parameter is discontinued.

    120
    InnerIp

    string

    The IP address used for mounting.

    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 of the elastic gateway node.

    string

    This parameter is discontinued.

    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 was successful.

    200
    EcsInstanceId

    string

    The ID of the ECS instance.

    i-uf62406gy5vyao4y8***
    Type

    string

    See the GatewayType parameter.

    File
    RenewURL

    string

    The renewal URL of the subscription gateway.

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

    string

    The ID of the VPC.

    vpc-uf6j237kxmsw08auey***
    ActivatedTime

    integer

    The time when the gateway was activated. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

    1578986214
    ElasticGateway

    boolean

    This parameter is discontinued.

    false
    CommonBuyInstanceId

    string

    The ID of the subscription gateway instance in the sales system.

    i-uf6gjr3lnwhyrd6hu***
    InnerIpv6Ip

    string

    The IPv6 address.

    2408:4004:110:6000:4656:f88e:1c14:e578
    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.

    UntrustedEnvInstanceType

    string

    The actual gateway class in an untrusted environment (CloudBox).

    UntrustedEnvOssEndpoint

    string

    The OSS endpoint of the gateway in an untrusted environment (CloudBox).

    HighAvailability

    boolean

    Indicates whether the gateway is a high availability (HA) gateway.

    SecondaryVSwitchId

    string

    The ID of the vSwitch for the secondary node of the HA gateway.

    Examples

    Success response

    JSON format

    {
  "Description": "",
  "CreatedTime": 1532099461,
  "PublicNetworkBandwidth": 50,
  "DataLoadType": "once",
  "Category": "Aliyun",
  "TaskId": "t-0000iwdggbharrw6r***",
  "Message": "successful",
  "ExpireStatus": 0,
  "Ip": "47.101.160.44",
  "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-intl.alibabacloud.com/?commodityCode=hcs_sgw_csg_pre&orderType=RENEW&instanceId=ca-0007va9bnideidndn***#/renew",
  "VpcId": "vpc-uf6j237kxmsw08auey***",
  "ActivatedTime": 1578986214,
  "ElasticGateway": false,
  "CommonBuyInstanceId": "i-uf6gjr3lnwhyrd6hu***",
  "InnerIpv6Ip": "2408:4004:110:6000:4656:f88e:1c14:e578",
  "LastErrorKey": "InternalError",
  "Location": "Cloud",
  "GatewayRegionId": "",
  "UntrustedEnvInstanceType": "",
  "UntrustedEnvOssEndpoint": "",
  "HighAvailability": true,
  "SecondaryVSwitchId": ""
}

    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.