すべてのプロダクト
Search

このプロダクト

    ENS:DescribeSDGs

    ドキュメントセンター

    ENS:DescribeSDGs

    最終更新日:Sep 08, 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:DescribeSDGs

    none

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SDGIds

    array

    任意

    クエリする SDG ID のリスト。

    string

    任意

    クエリする SDG ID。このパラメーターが空の場合、すべての SDG がクエリされます。

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

    array

    任意

    クエリする AIC インスタンス ID のリスト。

    string

    任意

    照会する AIC インスタンス ID。このパラメーターが空の場合、すべてのインスタンスが照会されます。

    説明

    SDGIds と InstanceIds の両方が指定されている場合、クエリ結果は 2 つの条件の共通部分となります。

    ["aic-1", "aic-2", "aic-3"]

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    3703C4AC-9396-458C-8F25-1D701334D309
    SDGs

    array<object>

    SDG 情報のリスト。

    array<object>

    SDG 情報のリスト。

    AvaliableRegionIds

    array<object>

    利用可能なエッジゾーンのリスト。

    object

    利用可能なエッジゾーンのリスト。

    CreationTime

    string

    エッジゾーンにおける SDG の作成時間。

    2023-02-27 15:13:26
    RegionId

    string

    エッジゾーン ID。

    cn-hangzhou-26
    SnapshotId

    string

    スナップショット ID。

    mock-clone_スナップショット_id
    Status

    string

    エッジゾーンにおける SDG のステータス。有効な値:

    • sdg_making: 作成中。

    • sdg_saving: 保存中。

    • sdg_copying: エッジゾーン間で同期中。

    • failed: 作成に失敗した。

    • success: 作成に成功しました。

    success
    CreationDiskType

    string

    SDG の作成に使用されたソースディスクのディスクタイプ。

    standard
    CreationRegionId

    string

    SDG が作成されたエッジゾーン ID。

    cn-hangzhou-26
    CreationTime

    string

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

    2023-02-27 15:07:21
    DeployedInstanceIds

    array<object>

    Deployment ステータス情報のリスト。

    object

    Deployment ステータス情報のリスト。

    CreationTime

    string

    SDG がインスタンスにデプロイされた時間。

    2023-02-27 16:48:43
    InstanceId

    string

    AIC インスタンス ID。

    aic-5x20dyeos****
    Status

    string

    Deployment ステータス。有効な値:

    • sdg_deploying: デプロイ中。

    • failed: Deployment に失敗した。

    • success: Deployment に成功しました。

    sdg_deploying
    DeploymentType

    string

    SDG の Deployment タイプ。有効な値:

    • common: 標準 Deployment

    • overlay: 読み取り/書き込み分離 Deployment

    overlay
    Description

    string

    SDG の説明。

    テスト 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
    UpdateTime

    string

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

    2023-02-27 16:04:39
    CreationInstanceId

    string

    SDG の作成に使用されたインスタンスの ID。

    aic-5x20dyeos****
    BillingType

    string

    課金タイプ。

    Open
    PerformanceLevel

    integer

    SDG の共有比率。

    100
    BillingCycle

    string

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

    Hour

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "3703C4AC-9396-458C-8F25-1D701334D309",
  "SDGs": [
    {
      "AvaliableRegionIds": [
        {
          "CreationTime": "2023-02-27 15:13:26",
          "RegionId": "cn-hangzhou-26",
          "SnapshotId": "mock-clone_snapshot_id",
          "Status": "success"
        }
      ],
      "CreationDiskType": "standard",
      "CreationRegionId": "cn-hangzhou-26",
      "CreationTime": "2023-02-27 15:07:21",
      "DeployedInstanceIds": [
        {
          "CreationTime": "2023-02-27 16:48:43",
          "InstanceId": "aic-5x20dyeos****",
          "Status": "sdg_deploying",
          "DeploymentType": "overlay"
        }
      ],
      "Description": "Test SDG",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39",
      "CreationInstanceId": "aic-5x20dyeos****",
      "BillingType": "Open",
      "PerformanceLevel": 100,
      "BillingCycle": "Hour"
    }
  ]
}

    エラーコード

    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.

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

    変更履歴

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