すべてのプロダクト
Search

このプロダクト

    ENS:DescribeSDG

    ドキュメントセンター

    ENS:DescribeSDG

    最終更新日:May 15, 2026

    ノードのプリロードの詳細を含む、共有データグループ (SDG) の基本情報を取得します。

    今すぐお試しください

    この 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:DescribeSDG

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SDGIds

    array

    任意

    SDG の ID。 省略した場合、すべての SDG が照会されます。

    string

    任意

    SDG の ID。

    ["sdg-1", "sdg-2", "sdg-3"]
    PageNumber

    integer

    任意

    返されるページ番号。

    1
    PageSize

    integer

    任意

    ページサイズ。

    デフォルト値：10。

    10
    SameDiskId

    boolean

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    F3B261DD-3858-4D3C-877D-303ADF374600
    SDGs

    array<object>

    SDG のリスト。

    array<object>

    AvaliableRegionIds

    array<object>

    SDG のスナップショットが利用可能なノード。

    object

    CreationTime

    string

    SDG がノード上に作成された日時。

    2023-02-27 15:13:26
    RegionId

    string

    ノード ID。

    cn-hangzhou-26
    SnapshotId

    string

    スナップショット ID。

    sp-517qu0tgznrg622he7nf4wd7n
    Status

    string

    ノード上の SDG のステータス。有効な値は次のとおりです：

    • sdg_making：作成中

    • sdg_saving：保存中

    • sdg_copying：ノード間での同期中

    • failed：失敗

    • success：成功

    success
    CreationInstanceId

    string

    SDG の作成元となったインスタンスの ID。

    aic-5x20dyeos****
    CreationDiskType

    string

    SDG の作成元となったソースディスクのディスクタイプ。

    standard
    CreationTime

    string

    SDG が最初に作成された日時。

    2023-02-27 15:07:21
    Description

    string

    SDG の説明。

    Test SDG
    ParentSDGId

    string

    増分作成のソース SDG の ID。これは、CreateSDG オペレーションを呼び出すときに渡す FromSDGId の値です。

    sdg-xxxxx
    SDGId

    string

    SDG の ID。

    sdg-30e1fdba7196bc****
    Size

    integer

    SDG のサイズ。単位：GB。

    20
    Status

    string

    SDG の作成ステータス。有効な値は次のとおりです：

    • sdg_making：作成中

    • sdg_saving：保存中

    • failed：失敗

    • success：成功

    success
    PerformanceLevel

    string

    SDG のパフォーマンスレベル。

    100
    UpdateTime

    string

    SDG が最後に更新された日時。

    2023-02-27 16:04:39
    PreloadInfos

    array<object>

    プレロード設定。

    object

    RegionId

    string

    ノード ID。

    cn-hangzhou
    Namespace

    string

    名前空間。

    test-20000
    RedundantNum

    integer

    共有マウントからの応答を高速化するための冗長コピーの数。

    2
    DiskType

    string

    冗長化された共有ディスクのディスクタイプ。

    standard
    CreationTime

    string

    エントリが作成された時刻。UTC で表示され、ISO 8601 形式 ( yyyy-MM-ddTHH:mm:ssZ ) に準拠します。

    2023-02-16T06:18:40Z
    UpdateTime

    string

    プレロードエントリのステータスが最後に更新された日時。

    2021-01-22T08:17Z
    CreationRegionId

    string

    SDG が作成されたノードの ID。

    cn-hangzhou-26
    BillingType

    string

    課金タイプ。

    Open
    BillingCycle

    string

    共有ディスクの課金サイクル。

    Day
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    各ページで返されるエントリの数。

    10
    TotalCount

    integer

    クエリに一致するエントリの総数。

    49

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600",
  "SDGs": [
    {
      "AvaliableRegionIds": [
        {
          "CreationTime": "2023-02-27 15:13:26",
          "RegionId": "cn-hangzhou-26",
          "SnapshotId": "sp-517qu0tgznrg622he7nf4wd7n",
          "Status": "success"
        }
      ],
      "CreationInstanceId": "aic-5x20dyeos****",
      "CreationDiskType": "standard",
      "CreationTime": "2023-02-27 15:07:21",
      "Description": "Test SDG",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "PerformanceLevel": "100",
      "UpdateTime": "2023-02-27 16:04:39",
      "PreloadInfos": [
        {
          "RegionId": "cn-hangzhou",
          "Namespace": "test-20000",
          "RedundantNum": 2,
          "DiskType": "standard",
          "CreationTime": "2023-02-16T06:18:40Z",
          "UpdateTime": "2021-01-22T08:17Z"
        }
      ],
      "CreationRegionId": "cn-hangzhou-26",
      "BillingType": "Open",
      "BillingCycle": "Day"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 49
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Interface.Call.Failed %s.
    400 Parameter.Invalid The parameter is invalid. Please check your parameters and try it again.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

    変更履歴

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