すべてのプロダクト
Search

このプロダクト

    ENS:DescribeStorageGateway

    ドキュメントセンター

    ENS:DescribeStorageGateway

    最終更新日:Mar 20, 2026

    ストレージゲートウェイを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ens:DescribeStorageGateway

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    EnsRegionId

    string

    任意

    ノードの ID。

    cn-beijing-cmcc
    GatewayId

    string

    任意

    ゲートウェイの ID。

    sgw-****
    GatewayType

    string

    任意

    ゲートウェイのタイプ。このパラメーターを 1 に設定します。1 は iSCSI を示します。

    1
    VpcId

    string

    任意

    VPC の ID。

    n-***
    PageNumber

    string

    任意

    ページ番号。デフォルト値：1。

    1
    PageSize

    string

    任意

    1 ページあたりのエントリ数。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエストの ID

    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。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

    VPC の ID。

    n-***
    CidrBlock

    string

    内部 CIDR ブロック。

    192.168.2.0/24
    PageNumber

    integer

    ページ番号。デフォルト値：1。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。

    デフォルト値：10。

    10
    TotalCount

    integer

    返されたエントリの総数。

    16

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。